docyard 0.3.0 → 0.4.0

data/lib/docyard/templates/markdown/guides/markdown-features.md.erb

@@ -0,0 +1,247 @@
+# Markdown Features
+
+Docyard supports GitHub Flavored Markdown (GFM) plus powerful custom components.
+
+## Basic Formatting
+
+Use standard markdown syntax for formatting:
+
+**Bold text** with `**bold**` or `__bold__`
+
+*Italic text* with `*italic*` or `_italic_`
+
+`Inline code` with \`backticks\`
+
+~~Strikethrough~~ with `~~text~~`
+
+## Headings
+
+```markdown
+# H1 Heading
+## H2 Heading
+### H3 Heading
+#### H4 Heading
+```
+
+## Lists
+
+Unordered lists:
+
+- Item one
+- Item two
+  - Nested item
+  - Another nested item
+- Item three
+
+Ordered lists:
+
+1. First step
+2. Second step
+3. Third step
+
+Task lists:
+
+- [x] Completed task
+- [ ] Pending task
+- [ ] Another pending task
+
+## Code Blocks
+
+Syntax highlighting for 100+ languages powered by Rouge:
+
+```javascript
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+
+console.log(greet('World'));
+```
+
+```python
+def greet(name):
+    return f"Hello, {name}!"
+
+print(greet('World'))
+```
+
+```ruby
+def greet(name)
+  "Hello, #{name}!"
+end
+
+puts greet('World')
+```
+
+Each code block includes a copy button for easy copying.
+
+## Tables
+
+Create responsive tables with GFM syntax:
+
+| Feature | Supported | Notes |
+|---------|-----------|-------|
+| Syntax highlighting | ✓ | 100+ languages |
+| Hot reload | ✓ | Instant updates |
+| Dark mode | ✓ | Auto-switching |
+| Mobile responsive | ✓ | Works everywhere |
+
+Tables automatically wrap on mobile devices.
+
+## Blockquotes
+
+> Standard blockquote for citations or highlights.
+>
+> Supports multiple paragraphs.
+
+## Links
+
+[Link to a page](../getting-started/installation)
+
+[External link](https://github.com)
+
+## Callouts
+
+Use callouts to highlight important information:
+
+::: note
+Informational content that provides additional context.
+:::
+
+::: tip Best Practice
+Helpful advice or recommendations for users.
+:::
+
+::: important
+Critical information that requires special attention.
+:::
+
+::: warning
+Caution about potential issues or things to watch out for.
+:::
+
+::: danger
+Severe warnings about dangerous operations or critical issues.
+:::
+
+### Custom Titles
+
+::: tip Performance Optimization
+You can customize the title of any callout type.
+:::
+
+### Rich Content
+
+::: important Key Requirements
+Callouts support all markdown features:
+
+- **Lists** and formatting
+- `Code snippets`
+- [Links](/)
+- Code blocks with syntax highlighting
+
+```ruby
+def example
+  puts "Code works inside callouts!"
+end
+```
+:::
+
+## Tabs
+
+Display multiple code examples or options in tabs:
+
+:::tabs
+== JavaScript
+```javascript
+const config = {
+  apiUrl: 'https://api.example.com',
+  timeout: 5000
+};
+```
+
+== TypeScript
+```typescript
+interface Config {
+  apiUrl: string;
+  timeout: number;
+}
+
+const config: Config = {
+  apiUrl: 'https://api.example.com',
+  timeout: 5000
+};
+```
+
+== Ruby
+```ruby
+config = {
+  api_url: 'https://api.example.com',
+  timeout: 5000
+}
+```
+:::
+
+### Package Manager Tabs
+
+Perfect for installation instructions:
+
+:::tabs
+== npm
+```bash
+npm install your-package
+```
+
+== yarn
+```bash
+yarn add your-package
+```
+
+== pnpm
+```bash
+pnpm add your-package
+```
+
+== bun
+```bash
+bun add your-package
+```
+:::
+
+Tabs automatically detect package managers and display appropriate icons.
+
+## Icons
+
+Use inline icons from [Phosphor Icons](https://phosphoricons.com):
+
+:rocket-launch: :check: :warning: :heart: :star: :code: :book-open: :gear:
+
+Just wrap the icon name in colons:
+
+```markdown
+:rocket-launch: :check: :warning:
+```
+
+Browse all available icons at [phosphoricons.com](https://phosphoricons.com).
+
+## Horizontal Rules
+
+Use three or more dashes, asterisks, or underscores:
+
+---
+
+## Best Practices
+
+::: tip Writing Great Documentation
+1. **Use headings hierarchically** - Don't skip levels (H1 → H3)
+2. **Add code examples** - Show, don't just tell
+3. **Use callouts sparingly** - Highlight only important information
+4. **Keep it concise** - Respect your readers' time
+5. **Link related pages** - Help users navigate your docs
+:::
+
+## Next Steps
+
+::: note
+- Learn how to [customize your site](configuration)
+- Explore the [installation guide](../getting-started/installation)
+:::

data/lib/docyard/templates/markdown/index.md.erb

@@ -1,86 +1,82 @@
-# Welcome to Docyard
+# Welcome to Your Documentation
 
-A modern, zero-config documentation generator for Ruby developers.
+This is your documentation homepage. Docyard transforms your Markdown files into beautiful, searchable documentation.
 
-## Features
+## Quick Example
 
-- **Auto-generated Navigation** - Sidebar built from your folder structure
-- **Hot Reload** - Changes appear instantly while you write
-- **GitHub Flavored Markdown** - Full GFM support with tables and task lists
-- **Syntax Highlighting** - 100+ languages powered by Rouge
-- **Zero Configuration** - Works out of the box with sensible defaults
-- **Mobile Responsive** - Beautiful on desktop, tablet, and mobile
+Here's what you can do with Docyard:
 
-## Quick Start
+### Code Blocks with Syntax Highlighting
 
-Get up and running in under a minute:
-
-```bash
-# Install
-gem install docyard
+```ruby
+class User
+  attr_reader :name, :email
 
-# Initialize
-docyard init
+  def initialize(name, email)
+    @name = name
+    @email = email
+  end
 
-# Start dev server
-docyard serve
+  def greet
+    "Hello, #{name}!"
+  end
+end
 ```
 
-Visit `http://localhost:4200` to see your docs.
+### Callouts for Important Information
 
+::: tip Pro Tip
+Use callouts to highlight important information. Available types: `note`, `tip`, `important`, `warning`, and `danger`.
+:::
 
-## Example Code
+::: warning
+Make sure to read the [Configuration Guide](guides/configuration) before deploying to production.
+:::
 
-Ruby with syntax highlighting:
+### Tabs for Multiple Options
 
-```ruby
-class DocumentationSite
-  attr_reader :title, :pages
+Show installation instructions for different package managers:
 
-  def initialize(title)
-    @title = title
-    @pages = []
-  end
+:::tabs
+== npm
+```bash
+npm install your-package
+```
 
-  def add_page(path, content)
-    pages << { path: path, content: content }
-  end
+== yarn
+```bash
+yarn add your-package
+```
 
-  def build
-    pages.each { |page| render_page(page) }
-  end
-end
+== pnpm
+```bash
+pnpm add your-package
 ```
+:::
 
+### Icons
 
-JavaScript example:
+Use inline icons from [Phosphor Icons](https://phosphoricons.com): :rocket-launch: :check: :warning: :heart:
 
-```javascript
-function buildDocs(config) {
-  const { title, theme } = config;
-  console.log(`Building ${title} with ${theme} theme`);
-  return { success: true };
-}
-```
+## Getting Started
+
+::: note Next Steps
+1. Edit the files in `docs/` to create your documentation
+2. Run `docyard serve` to preview changes in real-time
+3. Customize `docyard.yml` to configure branding and navigation
+4. Run `docyard build` when ready to deploy
+:::
 
 ## Documentation Structure
 
 | Section | Description |
 |---------|-------------|
-| Getting Started | Installation and quick start guide |
-| Core Concepts | Learn about file structure and markdown |
-
-## What's Next?
-
-> Get started by exploring the documentation in the sidebar, or jump straight to the [Quick Start Guide](getting-started/quick-start).
-
-### Learn the Basics
-
-1. [Introduction](getting-started/introduction) - Learn what Docyard can do
-2. [Installation](getting-started/installation) - Install Docyard on your system
-3. [Quick Start](getting-started/quick-start) - Create your first site
+| [Installation](getting-started/installation) | Get up and running quickly |
+| [Markdown Features](guides/markdown-features) | Learn about all supported features |
+| [Configuration](guides/configuration) | Customize appearance and navigation |
 
-### Understand Core Concepts
+## Need Help?
 
-- [File Structure](core-concepts/file-structure) - How to organize your docs
-- [Markdown](core-concepts/markdown) - Supported markdown features
+- Check out the [Markdown Features](guides/markdown-features) guide
+- Learn about [customization options](guides/configuration)
+- Explore the sidebar to see all available pages

data/lib/docyard/templates/partials/_nav_group.html.erb

@@ -1,7 +1,13 @@
-<button class="nav-group-toggle" aria-expanded="true" type="button">
-  <span><%= @title %></span>
-  <%= icon(:chevron) %>
+<% collapsed = @collapsed || false %>
+<button class="nav-group-toggle" aria-expanded="<%= collapsed ? 'false' : 'true' %>" type="button">
+  <span class="nav-group-title">
+    <% if @icon %>
+      <span class="nav-item-icon"><%= icon(@icon) %></span>
+    <% end %>
+    <span class="nav-item-text"><%= @title %></span>
+  </span>
+  <span class="nav-group-icon"><%= icon(:caret_right) %></span>
 </button>
-<div class="nav-group-children">
+<div class="nav-group-children<%= ' collapsed' if collapsed %>">
   <%= @children_html %>
 </div>

data/lib/docyard/templates/partials/_nav_leaf.html.erb

@@ -1 +1,9 @@
-<a href="<%= @path %>"<%= ' class="active"' if @active %>><%= @title %></a>
+<a href="<%= link_path(@path) %>"<%= ' class="active"' if @active %><%= " target=\"#{@target}\" rel=\"noopener noreferrer\"" if @target && @target != "_self" %>>
+  <% if @icon %>
+    <span class="nav-item-icon"><%= icon(@icon) %></span>
+  <% end %>
+  <span class="nav-item-text"><%= @title %></span>
+  <% if @target == "_blank" %>
+    <span class="nav-item-external"><%= icon(:link_external) %></span>
+  <% end %>
+</a>

data/lib/docyard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docyard
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/docyard.rb

@@ -22,5 +22,13 @@ require_relative "docyard/initializer"
 require_relative "docyard/server"
 require_relative "docyard/cli"
 
+# Build components
+require_relative "docyard/builder"
+require_relative "docyard/build/static_generator"
+require_relative "docyard/build/asset_bundler"
+require_relative "docyard/build/file_copier"
+require_relative "docyard/build/sitemap_generator"
+require_relative "docyard/preview_server"
+
 module Docyard
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sanif Himani
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cssminify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: terser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +184,11 @@ files:
 - Rakefile
 - lib/docyard.rb
 - lib/docyard/asset_handler.rb
+- lib/docyard/build/asset_bundler.rb
+- lib/docyard/build/file_copier.rb
+- lib/docyard/build/sitemap_generator.rb
+- lib/docyard/build/static_generator.rb
+- lib/docyard/builder.rb
 - lib/docyard/cli.rb
 - lib/docyard/components/base_processor.rb
 - lib/docyard/components/callout_processor.rb
@@ -150,6 +197,7 @@ files:
 - lib/docyard/components/icon_detector.rb
 - lib/docyard/components/icon_processor.rb
 - lib/docyard/components/registry.rb
+- lib/docyard/components/table_wrapper_processor.rb
 - lib/docyard/components/tabs_parser.rb
 - lib/docyard/components/tabs_processor.rb
 - lib/docyard/config.rb
@@ -165,12 +213,15 @@ files:
 - lib/docyard/language_mapping.rb
 - lib/docyard/logging.rb
 - lib/docyard/markdown.rb
+- lib/docyard/preview_server.rb
 - lib/docyard/rack_application.rb
 - lib/docyard/renderer.rb
 - lib/docyard/router.rb
 - lib/docyard/routing/resolution_result.rb
 - lib/docyard/server.rb
+- lib/docyard/sidebar/config_parser.rb
 - lib/docyard/sidebar/file_system_scanner.rb
+- lib/docyard/sidebar/item.rb
 - lib/docyard/sidebar/renderer.rb
 - lib/docyard/sidebar/title_extractor.rb
 - lib/docyard/sidebar/tree_builder.rb
@@ -191,6 +242,7 @@ files:
 - lib/docyard/templates/assets/css/variables.css
 - lib/docyard/templates/assets/favicon.svg
 - lib/docyard/templates/assets/js/components/code-block.js
+- lib/docyard/templates/assets/js/components/navigation.js
 - lib/docyard/templates/assets/js/components/tabs.js
 - lib/docyard/templates/assets/js/reload.js
 - lib/docyard/templates/assets/js/theme.js
@@ -200,21 +252,14 @@ files:
 - lib/docyard/templates/errors/404.html.erb
 - lib/docyard/templates/errors/500.html.erb
 - lib/docyard/templates/layouts/default.html.erb
-- lib/docyard/templates/markdown/components/callouts.md.erb
-- lib/docyard/templates/markdown/components/icons.md.erb
-- lib/docyard/templates/markdown/components/tabs.md.erb
-- lib/docyard/templates/markdown/configuration.md.erb
-- lib/docyard/templates/markdown/core-concepts/file-structure.md.erb
-- lib/docyard/templates/markdown/core-concepts/markdown.md.erb
 - lib/docyard/templates/markdown/getting-started/installation.md.erb
-- lib/docyard/templates/markdown/getting-started/introduction.md.erb
-- lib/docyard/templates/markdown/getting-started/quick-start.md.erb
+- lib/docyard/templates/markdown/guides/configuration.md.erb
+- lib/docyard/templates/markdown/guides/markdown-features.md.erb
 - lib/docyard/templates/markdown/index.md.erb
 - lib/docyard/templates/partials/_callout.html.erb
 - lib/docyard/templates/partials/_code_block.html.erb
 - lib/docyard/templates/partials/_icon.html.erb
 - lib/docyard/templates/partials/_icon_file_extension.html.erb
-- lib/docyard/templates/partials/_icons.html.erb
 - lib/docyard/templates/partials/_nav_group.html.erb
 - lib/docyard/templates/partials/_nav_item.html.erb
 - lib/docyard/templates/partials/_nav_leaf.html.erb