docyard 0.6.0 → 0.8.0

data/lib/docyard/sidebar/renderer.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Docyard
-  module Sidebar
-    class Renderer
-      PARTIALS_PATH = File.join(__dir__, "../templates/partials")
-
-      attr_reader :site_title, :base_url
-
-      def initialize(site_title: "Documentation", base_url: "/")
-        @site_title = site_title
-        @base_url = normalize_base_url(base_url)
-      end
-
-      def render(tree)
-        return "" if tree.empty?
-
-        nav_content = render_tree_with_sections(tree)
-        footer_html = render_partial(:sidebar_footer)
-
-        render_partial(:sidebar, nav_content: nav_content, footer_html: footer_html)
-      end
-
-      private
-
-      def render_partial(name, locals = {})
-        template_path = File.join(PARTIALS_PATH, "_#{name}.html.erb")
-        template = File.read(template_path)
-
-        locals.each { |key, value| instance_variable_set("@#{key}", value) }
-
-        erb_binding = binding
-        ERB.new(template).result(erb_binding)
-      end
-
-      def icon(name, weight = "regular")
-        Icons.render(name.to_s.tr("_", "-"), weight) || ""
-      end
-
-      def link_path(path)
-        return path if path.nil? || path.start_with?("http://", "https://")
-
-        "#{base_url.chomp('/')}#{path}"
-      end
-
-      def normalize_base_url(url)
-        return "/" if url.nil? || url.empty?
-
-        url = "/#{url}" unless url.start_with?("/")
-        url.end_with?("/") ? url : "#{url}/"
-      end
-
-      def render_tree_with_sections(items)
-        filtered_items = items.reject { |item| item[:title]&.downcase == site_title.downcase }
-        grouped_items = group_by_section(filtered_items)
-
-        grouped_items.map do |section_name, section_items|
-          render_section(section_name, section_items)
-        end.join
-      end
-
-      def render_section(section_name, section_items)
-        section_content = render_tree(section_items)
-        render_partial(:nav_section, section_name: section_name, section_content: section_content)
-      end
-
-      def group_by_section(items)
-        sections = {}
-        root_items = []
-
-        items.each do |item|
-          process_section_item(item, sections, root_items)
-        end
-
-        build_section_result(sections, root_items)
-      end
-
-      def process_section_item(item, sections, root_items)
-        return if item[:title]&.downcase == site_title.downcase
-
-        if item[:type] == :directory && !item[:children].empty?
-          section_name = item[:title].upcase
-          sections[section_name] = item[:children]
-        else
-          root_items << item
-        end
-      end
-
-      def build_section_result(sections, root_items)
-        result = {}
-        result[nil] = root_items unless root_items.empty?
-        result.merge!(sections)
-      end
-
-      def render_tree(items)
-        return "" if items.empty?
-
-        list_items = items.map { |item| render_item(item) }.join
-        render_partial(:nav_list, list_items: list_items)
-      end
-
-      def render_item(item)
-        item_content = if item[:children].empty?
-                         render_leaf_item(item)
-                       else
-                         render_group_item(item)
-                       end
-
-        render_partial(:nav_item, item_content: item_content)
-      end
-
-      def render_leaf_item(item)
-        render_partial(
-          :nav_leaf,
-          path: item[:path],
-          title: item[:title],
-          active: item[:active],
-          icon: item[:icon],
-          target: item[:target]
-        )
-      end
-
-      def render_group_item(item)
-        children_html = render_tree(item[:children])
-        render_partial(
-          :nav_group,
-          title: item[:title],
-          children_html: children_html,
-          icon: item[:icon],
-          collapsed: item[:collapsed]
-        )
-      end
-    end
-  end
-end

data/lib/docyard/sidebar/tree_builder.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  module Sidebar
-    class TreeBuilder
-      attr_reader :docs_path, :current_path, :title_extractor
-
-      def initialize(docs_path:, current_path:, title_extractor: TitleExtractor.new)
-        @docs_path = docs_path
-        @current_path = Utils::PathResolver.normalize(current_path)
-        @title_extractor = title_extractor
-      end
-
-      def build(file_items)
-        transform_items(file_items, "")
-      end
-
-      private
-
-      def transform_items(items, relative_base)
-        items.map do |item|
-          if item[:type] == :directory
-            transform_directory(item, relative_base)
-          else
-            transform_file(item, relative_base)
-          end
-        end
-      end
-
-      def transform_directory(item, relative_base)
-        dir_path = File.join(relative_base, item[:name])
-
-        {
-          title: Utils::TextFormatter.titleize(item[:name]),
-          path: nil,
-          active: false,
-          type: :directory,
-          collapsible: true,
-          collapsed: false,
-          children: transform_items(item[:children], dir_path)
-        }
-      end
-
-      def transform_file(item, relative_base)
-        file_path = File.join(relative_base, "#{item[:name]}#{Constants::MARKDOWN_EXTENSION}")
-        full_file_path = File.join(docs_path, file_path)
-        url_path = Utils::PathResolver.to_url(file_path.delete_suffix(Constants::MARKDOWN_EXTENSION))
-
-        {
-          title: title_extractor.extract(full_file_path),
-          path: url_path,
-          active: current_path == url_path,
-          type: :file,
-          children: []
-        }
-      end
-    end
-  end
-end

data/lib/docyard/sidebar_builder.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "sidebar/file_system_scanner"
-require_relative "sidebar/title_extractor"
-require_relative "sidebar/tree_builder"
-require_relative "sidebar/renderer"
-require_relative "sidebar/config_parser"
-
-module Docyard
-  class SidebarBuilder
-    attr_reader :docs_path, :current_path, :config
-
-    def initialize(docs_path:, current_path: "/", config: nil)
-      @docs_path = docs_path
-      @current_path = current_path
-      @config = config
-    end
-
-    def tree
-      @tree ||= build_tree
-    end
-
-    def to_html
-      renderer.render(tree)
-    end
-
-    private
-
-    def build_tree
-      if config_sidebar_items?
-        build_tree_from_config
-      else
-        build_tree_from_filesystem
-      end
-    end
-
-    def build_tree_from_config
-      config_parser.parse.map(&:to_h)
-    end
-
-    def build_tree_from_filesystem
-      file_items = scanner.scan
-      tree_builder.build(file_items)
-    end
-
-    def config_sidebar_items?
-      config_sidebar_items&.any?
-    end
-
-    def config_sidebar_items
-      return [] unless config
-
-      if config.is_a?(Hash)
-        config.dig("sidebar", "items") || config.dig(:sidebar, :items) || []
-      else
-        config.sidebar&.items || []
-      end
-    end
-
-    def config_parser
-      @config_parser ||= Sidebar::ConfigParser.new(
-        config_sidebar_items,
-        docs_path: docs_path,
-        current_path: current_path
-      )
-    end
-
-    def scanner
-      @scanner ||= Sidebar::FileSystemScanner.new(docs_path)
-    end
-
-    def tree_builder
-      @tree_builder ||= Sidebar::TreeBuilder.new(
-        docs_path: docs_path,
-        current_path: current_path
-      )
-    end
-
-    def renderer
-      @renderer ||= Sidebar::Renderer.new(
-        site_title: extract_site_title,
-        base_url: extract_base_url
-      )
-    end
-
-    def extract_base_url
-      if config.is_a?(Hash)
-        config.dig(:build, :base_url) || "/"
-      else
-        config&.build&.base_url || "/"
-      end
-    end
-
-    def extract_site_title
-      if config.is_a?(Hash)
-        config[:site_title] || "Documentation"
-      else
-        config&.site&.title || "Documentation"
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-# Installation
-
-Get your documentation site up and running in minutes.
-
-## Prerequisites
-
-::: note Requirements
-- Ruby 3.0 or higher
-- Bundler (optional, for Gemfile-based projects)
-:::
-
-Check your Ruby version:
-
-```bash
-ruby --version
-```
-
-## Install Docyard
-
-:::tabs
-== Gem Install
-```bash
-gem install docyard
-```
-
-== Bundler
-Add to your `Gemfile`:
-
-```ruby
-gem 'docyard'
-```
-
-Then install:
-
-```bash
-bundle install
-```
-:::
-
-## Verify Installation
-
-Check that Docyard was installed successfully:
-
-```bash
-docyard version
-```
-
-## Quick Start
-
-Initialize a new documentation project:
-
-```bash
-# Create new project
-docyard init
-
-# Start development server
-docyard serve
-```
-
-Visit [http://localhost:4200](http://localhost:4200) to see your documentation.
-
-## Available Commands
-
-| Command | Description |
-|---------|-------------|
-| `docyard init` | Initialize a new documentation project |
-| `docyard serve` | Start development server with hot reload |
-| `docyard build` | Build static site for production |
-| `docyard preview` | Preview production build locally |
-
-## Next Steps
-
-::: tip What's Next?
-- Explore [Markdown Features](../guides/markdown-features) to see what you can do
-- Learn about [Configuration](../guides/configuration) options
-- Start writing your documentation!
-:::

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!
-:::