docyard 0.2.0 → 0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 0.2.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
@@ -137,47 +179,87 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENSE.txt
+- LICENSE.vscode-icons
 - README.md
 - 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
+- lib/docyard/components/code_block_processor.rb
+- lib/docyard/components/code_detector.rb
+- 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
+- lib/docyard/config/validator.rb
 - lib/docyard/constants.rb
 - lib/docyard/errors.rb
 - lib/docyard/file_watcher.rb
+- lib/docyard/icons.rb
+- lib/docyard/icons/LICENSE.phosphor
+- lib/docyard/icons/file_types.rb
+- lib/docyard/icons/phosphor.rb
 - lib/docyard/initializer.rb
+- 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
 - lib/docyard/sidebar_builder.rb
 - lib/docyard/templates/assets/css/code.css
-- lib/docyard/templates/assets/css/components.css
+- lib/docyard/templates/assets/css/components/callout.css
+- lib/docyard/templates/assets/css/components/code-block.css
+- lib/docyard/templates/assets/css/components/icon.css
+- lib/docyard/templates/assets/css/components/logo.css
+- lib/docyard/templates/assets/css/components/navigation.css
+- lib/docyard/templates/assets/css/components/tabs.css
+- lib/docyard/templates/assets/css/components/theme-toggle.css
 - lib/docyard/templates/assets/css/layout.css
 - lib/docyard/templates/assets/css/main.css
 - lib/docyard/templates/assets/css/markdown.css
 - lib/docyard/templates/assets/css/reset.css
 - lib/docyard/templates/assets/css/typography.css
 - 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
+- lib/docyard/templates/assets/logo-dark.svg
+- lib/docyard/templates/assets/logo.svg
+- lib/docyard/templates/config/docyard.yml.erb
 - 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/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/_icons.html.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/_nav_group.html.erb
 - lib/docyard/templates/partials/_nav_item.html.erb
 - lib/docyard/templates/partials/_nav_leaf.html.erb
@@ -185,6 +267,8 @@ files:
 - lib/docyard/templates/partials/_nav_section.html.erb
 - lib/docyard/templates/partials/_sidebar.html.erb
 - lib/docyard/templates/partials/_sidebar_footer.html.erb
+- lib/docyard/templates/partials/_tabs.html.erb
+- lib/docyard/templates/partials/_theme_toggle.html.erb
 - lib/docyard/utils/path_resolver.rb
 - lib/docyard/utils/text_formatter.rb
 - lib/docyard/version.rb

data/lib/docyard/templates/markdown/core-concepts/file-structure.md.erb

@@ -1,61 +0,0 @@
-# File Structure
-
-Understanding how Docyard organizes your documentation.
-
-## Basic Structure
-
-```bash
-docs/
-├── index.md              # Home page
-├── getting-started/      # Section folder
-│   ├── introduction.md
-│   └── quick-start.md
-└── guides/              # Another section
-    └── tutorial.md
-```
-
-## Navigation Rules
-
-- **Folders become sections** in the sidebar navigation
-- **Files become pages** within those sections
-- Files are sorted alphabetically
-- `index.md` in the root is your home page
-
-## File Naming
-
-File names are automatically converted to page titles:
-
-- `quick-start.md` → "Quick Start"
-- `api-reference.md` → "Api Reference"
-- `getting_started.md` → "Getting Started"
-
-## Custom Titles
-
-Override the auto-generated title using an H1 heading:
-
-```markdown
-# Custom Page Title
-
-Your content here...
-```
-
-## Hidden Files
-
-Files and folders starting with `_` or `.` are ignored:
-
-- `_draft.md` - Not included
-- `.notes.md` - Not included
-- `published.md` - Included
-
-## Nested Sections
-
-You can nest folders to create sub-sections:
-
-```bash
-docs/
-└── api/
-    ├── classes/
-    │   └── generator.md
-    └── modules/
-        └── utils.md
-```

data/lib/docyard/templates/markdown/core-concepts/markdown.md.erb

@@ -1,90 +0,0 @@
-# Markdown Support
-
-Docyard supports GitHub Flavored Markdown with syntax highlighting.
-
-## Headings
-
-```markdown
-# H1 Heading
-## H2 Heading
-### H3 Heading
-```
-
-
-## Text Formatting
-
-**Bold text** with `**bold**`
-*Italic text* with `*italic*`
-~~Strikethrough~~ with `~~strikethrough~~`
-
-## Lists
-
-Unordered lists:
-
-- Item 1
-- Item 2
-  - Nested item
-  - Another nested
-
-Ordered lists:
-
-1. First step
-2. Second step
-3. Third step
-
-## Code
-
-Inline code: `const x = 42`
-
-Code blocks with syntax highlighting:
-
-```ruby
-class DocumentationGenerator
-  def initialize(title)
-    @title = title
-  end
-
-  def build
-    puts "Building #{@title}..."
-  end
-end
-```
-
-```javascript
-function generateDocs(title) {
-  console.log(`Building ${title}...`);
-  return { success: true };
-}
-```
-
-
-## Tables
-
-| Feature | Status | Priority |
-|---------|--------|----------|
-| Sidebar | Done | High |
-| Search | Planned | Medium |
-| Dark Mode | Planned | High |
-
-## Links
-
-[External link](https://github.com)
-[Internal link](file-structure)
-[Link to section](../getting-started/installation)
-
-## Blockquotes
-
-> This is a blockquote. Use it to highlight important information or callouts.
-
-## Images
-
-```markdown
-![Alt text](/path/to/image.png)
-```
-
-
-## Task Lists
-
-- [x] Completed task
-- [ ] Incomplete task
-- [ ] Another task

data/lib/docyard/templates/markdown/getting-started/introduction.md.erb

@@ -1,30 +0,0 @@
-# Introduction
-
-Welcome to Docyard - a modern, zero-config documentation generator for Ruby developers.
-
-## What is Docyard?
-
-Docyard turns your Markdown files into beautiful, searchable documentation sites. Write docs in Markdown, and Docyard handles the rest.
-
-## Key Features
-
-- **Auto-generated Navigation** - Sidebar navigation built from your folder structure
-- **Hot Reload** - See changes instantly as you write
-- **GitHub Flavored Markdown** - Full GFM support including tables and task lists
-- **Syntax Highlighting** - 100+ languages powered by Rouge
-- **Zero Configuration** - Works out of the box with sensible defaults
-- **Mobile Responsive** - Looks great on all devices
-
-## Philosophy
-
-Docyard follows these principles:
-
-1. **Simple by default** - No configuration needed to get started
-2. **Markdown-first** - Focus on writing, not tooling
-3. **Beautiful out of the box** - Production-ready styling included
-4. **Developer friendly** - Built by developers, for developers
-
-## Next Steps
-
-- [Install Docyard](installation) to get started
-- Check out the [Quick Start Guide](quick-start) for a 5-minute tutorial

data/lib/docyard/templates/markdown/getting-started/quick-start.md.erb

@@ -1,56 +0,0 @@
-# Quick Start
-
-Get up and running with Docyard in under 5 minutes.
-
-## 1. Install Docyard
-
-```bash
-gem install docyard
-```
-
-## 2. Initialize Your Project
-
-Create a new documentation project:
-
-```bash
-docyard init
-```
-
-
-This creates a `docs/` folder with sample documentation files.
-
-## 3. Start the Dev Server
-
-```bash
-docyard serve
-```
-
-
-Your documentation will be available at `http://localhost:4200`.
-
-## 4. Edit Your Docs
-
-Open `docs/index.md` and make some changes. The browser will automatically reload to show your changes.
-
-## 5. Organize Your Content
-
-Create folders to organize your documentation:
-
-```bash
-docs/
-├── index.md
-├── getting-started/
-│   ├── introduction.md
-│   └── installation.md
-└── guides/
-    ├── basic-usage.md
-    └── advanced-features.md
-```
-
-
-The sidebar navigation will automatically reflect your folder structure.
-
-## What's Next?
-
-- Learn about [File Structure](../core-concepts/file-structure) conventions
-- Explore [Markdown](../core-concepts/markdown) syntax and features

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

@@ -1,11 +0,0 @@
-<%# External link icon %>
-<% if @icon_name == :external %>
-  <svg class="external-icon" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
-    <path d="M224,104a8,8,0,0,1-16,0V59.32l-66.33,66.34a8,8,0,0,1-11.32-11.32L196.68,48H152a8,8,0,0,1,0-16h64a8,8,0,0,1,8,8Zm-40,24a8,8,0,0,0-8,8v72H48V80h72a8,8,0,0,0,0-16H48A16,16,0,0,0,32,80V208a16,16,0,0,0,16,16H176a16,16,0,0,0,16-16V136A8,8,0,0,0,184,128Z" />
-  </svg>
-<%# Chevron icon %>
-<% elsif @icon_name == :chevron %>
-  <svg class="nav-group-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor">
-    <path d="M181.66,133.66l-80,80a8,8,0,0,1-11.32-11.32L164.69,128,90.34,53.66a8,8,0,0,1,11.32-11.32l80,80A8,8,0,0,1,181.66,133.66Z"/>
-  </svg>
-<% end %>