docyard 0.3.0 → 0.4.0

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

@@ -1,202 +0,0 @@
----
-title: Configuration
----
-
-# Configuration
-
-Docyard uses convention over configuration. You can start using Docyard without any configuration file - it just works!
-
-## Optional Configuration
-
-Create a `docyard.yml` file in your project root to customize your documentation site.
-
-```yaml
-site:
-  title: "My Documentation"
-  description: "Documentation for my project"
-
-build:
-  output_dir: "dist"
-  base_url: "/"
-```
-
-## Configuration Reference
-
-### Site Settings
-
-Configure your site metadata and branding.
-
-#### `site.title`
-
-The title of your documentation site. Shown in the browser tab and header.
-
-- **Type:** String
-- **Default:** `"Documentation"`
-
-```yaml
-site:
-  title: "My Project Docs"
-```
-
-#### `site.description`
-
-Meta description for SEO and social sharing.
-
-- **Type:** String
-- **Default:** `""`
-
-```yaml
-site:
-  description: "Complete documentation for My Project"
-```
-
-#### `site.logo`
-
-Path to your logo image. Displayed in the site header.
-
-- **Type:** String (file path)
-- **Default:** None
-- **Supported formats:** SVG, PNG, JPG
-
-```yaml
-site:
-  logo: "docs/assets/logo.svg"
-```
-
-::: tip
-Use SVG format for your logo for best quality at all screen sizes.
-:::
-
-#### `site.logo_dark`
-
-Optional dark mode variant of your logo.
-
-- **Type:** String (file path)
-- **Default:** None
-
-```yaml
-site:
-  logo: "docs/assets/logo.svg"
-  logo_dark: "docs/assets/logo-dark.svg"
-```
-
-#### `site.favicon`
-
-Path to your favicon.
-
-- **Type:** String (file path)
-- **Default:** None
-- **Supported formats:** `.ico`, `.png`
-
-```yaml
-site:
-  favicon: "docs/assets/favicon.ico"
-```
-
-### Build Settings
-
-Configure static site generation.
-
-#### `build.output_dir`
-
-Directory where the built site will be generated.
-
-- **Type:** String
-- **Default:** `"dist"`
-- **Note:** Cannot contain slashes
-
-```yaml
-build:
-  output_dir: "dist"  # or "_site", "public", etc.
-```
-
-#### `build.base_url`
-
-Base URL for your site. Important for subdirectory deployments.
-
-- **Type:** String
-- **Default:** `"/"`
-- **Note:** Must start with `/`
-
-```yaml
-# For root deployment
-build:
-  base_url: "/"
-
-# For GitHub Pages project site
-build:
-  base_url: "/my-repo/"
-```
-
-::: important
-Set `base_url` correctly for subdirectory deployments (like GitHub Pages project sites) or your assets won't load correctly.
-:::
-
-#### `build.clean`
-
-Whether to clean the output directory before building.
-
-- **Type:** Boolean
-- **Default:** `true`
-
-```yaml
-build:
-  clean: true  # Recommended
-```
-
-## Examples
-
-### Basic Configuration
-
-Minimal config with just a custom title:
-
-```yaml
-site:
-  title: "Acme Documentation"
-```
-
-### Full Branding
-
-Complete branding with logo and favicon:
-
-```yaml
-site:
-  title: "Acme Inc."
-  description: "API documentation for Acme services"
-  logo: "docs/assets/logo.svg"
-  logo_dark: "docs/assets/logo-dark.svg"
-  favicon: "docs/assets/favicon.ico"
-```
-
-### GitHub Pages Deployment
-
-Configuration for GitHub Pages subdirectory:
-
-```yaml
-site:
-  title: "My Project"
-
-build:
-  base_url: "/my-repo/"
-```
-
-### Custom Output Directory
-
-Using a different output directory:
-
-```yaml
-build:
-  output_dir: "public"
-  base_url: "/"
-```
-
-## No Configuration Required
-
-If you don't create a `docyard.yml` file, Docyard will work with sensible defaults:
-
-- Site title: `"Documentation"`
-- Output directory: `dist/`
-- Base URL: `/`
-- Clean build: `true`
-
-This means you can run `docyard serve` immediately after `docyard init` without any additional configuration!

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 %>