docyard 0.7.0 → 0.8.0

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

@@ -1,202 +0,0 @@
-# Configuration
-
-Customize your documentation site with `docyard.yml`.
-
-## Getting Started
-
-Docyard works without any configuration, but you can customize it by creating a `docyard.yml` file in your project root.
-
-::: tip
-The `docyard init` command creates a `docyard.yml` file with helpful examples.
-:::
-
-## Basic Configuration
-
-```yaml
-site:
-  title: "My Documentation"
-  description: "Documentation for my project"
-```
-
-## Branding
-
-### Custom Logo
-
-Add your own logo:
-
-```yaml
-branding:
-  logo: "assets/logo.svg"           # Light mode logo
-  logo_dark: "assets/logo-dark.svg" # Dark mode logo (optional)
-  favicon: "assets/favicon.svg"      # Browser tab icon
-```
-
-::: note File Paths
-- Paths are relative to the `docs/` directory
-- Or use full URLs: `https://cdn.example.com/logo.svg`
-- Supported formats: SVG, PNG, JPG
-:::
-
-### Logo Visibility
-
-Control what appears in the header:
-
-```yaml
-branding:
-  appearance:
-    logo: true   # Show/hide logo
-    title: true  # Show/hide site title
-```
-
-## Sidebar Navigation
-
-Customize the sidebar structure and order:
-
-```yaml
-sidebar:
-  items:
-    # Simple page reference
-    - installation
-
-    # Page with custom text
-    - quick-start:
-        text: "Quick Start Guide"
-
-    # Page with icon
-    - configuration:
-        text: "Configuration"
-        icon: "gear"
-
-    # Nested group
-    - guides:
-        text: "User Guides"
-        icon: "book-open"
-        items:
-          - markdown-features
-          - customization
-
-    # External link
-    - text: "GitHub"
-      link: "https://github.com/yourusername/yourproject"
-      icon: "github-logo"
-      target: "_blank"
-```
-
-::: tip Icons
-Browse available icons at [phosphoricons.com](https://phosphoricons.com). Just use the icon name (e.g., `rocket-launch`, `book-open`).
-:::
-
-### Collapsible Groups
-
-Control whether groups start expanded or collapsed:
-
-```yaml
-sidebar:
-  items:
-    - api:
-        text: "API Reference"
-        collapsed: true  # Start collapsed
-        items:
-          - authentication
-          - endpoints
-          - errors
-```
-
-## Build Configuration
-
-Configure the build output:
-
-```yaml
-build:
-  output_dir: "dist"      # Output directory for built site
-  base_url: "/"           # Base URL for deployment
-  clean: true             # Clean output directory before building
-```
-
-### Base URL
-
-Set the base URL for subdirectory deployments:
-
-```yaml
-build:
-  base_url: "/docs/"  # For example.com/docs/
-```
-
-::: warning Base URL
-If deploying to a subdirectory, make sure base_url matches your deployment path. Otherwise assets won't load correctly.
-:::
-
-## Complete Example
-
-Here's a full configuration file:
-
-```yaml
-site:
-  title: "Acme API Documentation"
-  description: "Official API documentation for Acme"
-
-branding:
-  logo: "assets/logo.svg"
-  logo_dark: "assets/logo-dark.svg"
-  favicon: "assets/favicon.svg"
-  appearance:
-    logo: true
-    title: true
-
-sidebar:
-  items:
-    - index
-
-    - getting-started:
-        text: "Getting Started"
-        icon: "rocket-launch"
-        items:
-          - installation
-          - authentication
-          - quick-start
-
-    - guides:
-        text: "Guides"
-        icon: "book-open"
-        items:
-          - making-requests
-          - error-handling
-          - rate-limiting
-
-    - api:
-        text: "API Reference"
-        icon: "code"
-        collapsed: false
-        items:
-          - users
-          - products
-          - orders
-
-    - text: "GitHub"
-      link: "https://github.com/acme/api"
-      icon: "github-logo"
-      target: "_blank"
-
-build:
-  output_dir: "dist"
-  base_url: "/api/"
-  clean: true
-```
-
-## Configuration Tips
-
-::: tip Best Practices
-1. **Start simple** - Add configuration as you need it
-2. **Use icons consistently** - Pick a set and stick with it
-3. **Organize logically** - Group related pages together
-4. **Test base_url** - Preview with `docyard preview` before deploying
-5. **Keep it maintainable** - Don't over-configure
-:::
-
-## Next Steps
-
-::: note
-- Learn about [markdown features](markdown-features)
-- Check the [installation guide](../getting-started/installation)
-- Start customizing your site!
-:::

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

@@ -1,247 +0,0 @@
-# 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,82 +0,0 @@
-# Welcome to Your Documentation
-
-This is your documentation homepage. Docyard transforms your Markdown files into beautiful, searchable documentation.
-
-## Quick Example
-
-Here's what you can do with Docyard:
-
-### Code Blocks with Syntax Highlighting
-
-```ruby
-class User
-  attr_reader :name, :email
-
-  def initialize(name, email)
-    @name = name
-    @email = email
-  end
-
-  def greet
-    "Hello, #{name}!"
-  end
-end
-```
-
-### Callouts for Important Information
-
-::: tip Pro Tip
-Use callouts to highlight important information. Available types: `note`, `tip`, `important`, `warning`, and `danger`.
-:::
-
-::: warning
-Make sure to read the [Configuration Guide](guides/configuration) before deploying to production.
-:::
-
-### Tabs for Multiple Options
-
-Show installation instructions for different package managers:
-
-:::tabs
-== npm
-```bash
-npm install your-package
-```
-
-== yarn
-```bash
-yarn add your-package
-```
-
-== pnpm
-```bash
-pnpm add your-package
-```
-:::
-
-### Icons
-
-Use inline icons from [Phosphor Icons](https://phosphoricons.com): :rocket-launch: :check: :warning: :heart:
-
-## 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 |
-|---------|-------------|
-| [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 |
-
-## Need Help?
-
-- Check out the [Markdown Features](guides/markdown-features) guide
-- Learn about [customization options](guides/configuration)
-- Explore the sidebar to see all available pages