docyard 0.9.0 → 1.0.0

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,19 +0,0 @@
----
-name: Feature Request
-about: Suggest a feature
-title: ''
-labels: enhancement
-assignees: ''
----
-
-## Description
-
-<!-- What feature would you like? -->
-
-## Use Case
-
-<!-- Why is this useful? When would you use it? -->
-
-## Implementation Ideas
-
-<!-- Optional: How might this work? -->

data/.github/pull_request_template.md

@@ -1,14 +0,0 @@
-## Description
-
-<!-- What does this PR do? -->
-
-## Changes
-
--
--
-
-## Checklist
-
-- [ ] Tests added/updated
-- [ ] CHANGELOG.md updated
-- [ ] README.md updated (if needed)

data/.github/workflows/ci.yml

@@ -1,49 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    name: Ruby ${{ matrix.ruby }} - Test
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.2', '3.3', '3.4', 'head']
-    continue-on-error: ${{ matrix.ruby == 'head' }}
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: bundle exec rspec
-        env:
-            RUBYOPT: '-W0'
-
-  lint:
-    name: Rubocop
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-
-      - name: Run rubocop
-        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,42 +0,0 @@
-plugins:
-  - rubocop-rspec
-  - rubocop-rake
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.2
-  Exclude:
-    - 'vendor/**/*'
-    - 'spec/fixtures/**/*'
-    - 'tmp/**/*'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-    - '*.gemspec'
-
-RSpec/ExampleLength:
-  Max: 15
-
-Metrics/ClassLength:
-  Max: 150
-
-Metrics/MethodLength:
-  Max: 16
-
-Metrics/ParameterLists:
-  MaxOptionalParameters: 6
-  CountKeywordArgs: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -1,55 +0,0 @@
-# Contributing
-
-Thanks for wanting to contribute to Docyard!
-
-## Development Setup
-
-```bash
-git clone https://github.com/YOUR_USERNAME/docyard.git
-cd docyard
-bundle install
-
-# Run tests
-bundle exec rspec
-bundle exec rubocop
-
-# Test locally
-./bin/docyard init
-./bin/docyard serve
-```
-
-## Pull Requests
-
-1. Fork the repo and create a branch from `main`
-2. Write tests for new features
-3. Run `bundle exec rspec && bundle exec rubocop`
-4. Update README/CHANGELOG if needed
-5. Use conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`
-
-## Architecture
-
-```
-lib/docyard/
-  cli.rb              # CLI
-  server.rb           # Server lifecycle
-  rack_application.rb # HTTP handling
-  router.rb           # URL → file mapping
-  renderer.rb         # Markdown → HTML
-  markdown.rb         # Parsing
-  file_watcher.rb     # Live reload
-  asset_handler.rb    # Static assets
-```
-
-## Code Style
-
-- Maintain >85% test coverage
-- Keep methods focused and readable
-- Add tests for new features
-
-## Questions?
-
-Open an issue.
-
----
-
-Thanks for contributing! 🚀

data/LICENSE.vscode-icons

@@ -1,42 +0,0 @@
-File Type Icons from VSCode Icons
-=====================================
-
-The file type icons embedded in lib/docyard/icons/file_types.rb are from the VSCode Icons project:
-https://github.com/vscode-icons/vscode-icons
-
-License: Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
-https://creativecommons.org/licenses/by-sa/4.0/
-
-Copyright (c) 2016 Roberto Huertas
-
-Icons included:
-- JavaScript (.js)
-- TypeScript (.ts)
-- JSX (.jsx)
-- TSX (.tsx)
-- Python (.py)
-- Ruby (.rb)
-- HTML (.html)
-- CSS (.css)
-- JSON (.json)
-- YAML (.yaml)
-- TOML (.toml)
-- Go (.go)
-- Rust (.rs)
-- PHP (.php)
-- SQL (.sql)
-- MySQL (.mysql)
-- PostgreSQL (.pgsql)
-- GraphQL (.graphql)
-- Vue (.vue)
-- Svelte (.svelte)
-- Protobuf (.proto)
-
-These icons are used under the terms of the CC BY-SA 4.0 license.
-You are free to:
-- Share — copy and redistribute the material in any medium or format
-- Adapt — remix, transform, and build upon the material for any purpose, even commercially
-
-Under the following terms:
-- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made
-- ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/docyard/config/constants.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  module Constants
-    CONTENT_TYPE_HTML = "text/html; charset=utf-8"
-    CONTENT_TYPE_JSON = "application/json; charset=utf-8"
-    CONTENT_TYPE_CSS = "text/css; charset=utf-8"
-    CONTENT_TYPE_JS = "application/javascript; charset=utf-8"
-
-    RELOAD_ENDPOINT = "/_docyard/reload"
-    DOCYARD_ASSETS_PREFIX = "/_docyard/"
-    PAGEFIND_PREFIX = "/pagefind/"
-    PUBLIC_DIR = "docs/public"
-
-    INDEX_FILE = "index"
-    INDEX_TITLE = "Home"
-
-    MARKDOWN_EXTENSION = ".md"
-    HTML_EXTENSION = ".html"
-
-    STATUS_OK = 200
-    STATUS_REDIRECT = 302
-    STATUS_NOT_FOUND = 404
-    STATUS_INTERNAL_ERROR = 500
-
-    DEFAULT_SITE_TITLE = "Documentation"
-    DEFAULT_LOGO_PATH = "_docyard/logo.svg"
-    DEFAULT_LOGO_DARK_PATH = "_docyard/logo-dark.svg"
-    DEFAULT_FAVICON_PATH = "_docyard/favicon.svg"
-  end
-end

data/lib/docyard/navigation/sidebar/children_discoverer.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  module Sidebar
-    class ChildrenDiscoverer
-      attr_reader :docs_path
-
-      def initialize(docs_path:)
-        @docs_path = docs_path
-      end
-
-      def discover(relative_path, depth:, &item_builder)
-        full_path = File.join(docs_path, relative_path)
-        return [] unless File.directory?(full_path)
-
-        local_config = load_local_sidebar_config(full_path)
-        return yield(local_config, relative_path, depth) if local_config
-
-        discover_from_filesystem(full_path, relative_path, depth, &item_builder)
-      end
-
-      private
-
-      def load_local_sidebar_config(dir_path)
-        LocalConfigLoader.new(dir_path).load
-      end
-
-      def discover_from_filesystem(full_path, relative_path, depth, &item_builder)
-        entries = filtered_entries(full_path)
-        entries.map { |entry| build_entry(entry, full_path, relative_path, depth, &item_builder) }.compact
-      end
-
-      def filtered_entries(full_path)
-        Dir.children(full_path)
-          .reject { |e| e.start_with?(".") || e.start_with?("_") || e == "index.md" }
-          .sort
-      end
-
-      def build_entry(entry, full_path, relative_path, depth)
-        entry_path = File.join(full_path, entry)
-
-        if File.directory?(entry_path)
-          yield(:directory, entry, relative_path, depth)
-        elsif entry.end_with?(".md")
-          slug = entry.delete_suffix(".md")
-          yield(:file, slug, relative_path, depth)
-        end
-      end
-    end
-  end
-end

data/lib/docyard/navigation/sidebar/config_parser.rb

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "item"
-require_relative "title_extractor"
-require_relative "metadata_extractor"
-require_relative "children_discoverer"
-require_relative "file_resolver"
-
-module Docyard
-  module Sidebar
-    class ConfigParser # rubocop:disable Metrics/ClassLength
-      attr_reader :config_items, :docs_path, :current_path, :metadata_extractor,
-                  :children_discoverer, :file_resolver
-
-      def initialize(config_items, docs_path:, current_path: "/", title_extractor: TitleExtractor.new)
-        @config_items = config_items || []
-        @docs_path = docs_path
-        @current_path = Utils::PathResolver.normalize(current_path)
-        @metadata_extractor = MetadataExtractor.new(docs_path: docs_path, title_extractor: title_extractor)
-        @children_discoverer = ChildrenDiscoverer.new(docs_path: docs_path)
-        @file_resolver = FileResolver.new(
-          docs_path: docs_path, current_path: @current_path, metadata_extractor: metadata_extractor
-        )
-      end
-
-      def parse
-        parse_items(config_items, "", depth: 1)
-      end
-
-      private
-
-      def parse_items(items, base_path, depth:)
-        items.map { |item_config| parse_item(item_config, base_path, depth: depth) }.compact
-      end
-
-      def parse_item(item_config, base_path, depth:)
-        case item_config
-        when String then resolve_string_item(item_config, base_path, depth: depth)
-        when Hash then parse_hash_item(item_config, base_path, depth: depth)
-        end
-      end
-
-      def resolve_string_item(slug, base_path, depth:)
-        if File.directory?(File.join(docs_path, base_path, slug))
-          build_directory_item(slug, {}, [], base_path, depth: depth)
-        else
-          file_resolver.resolve(slug, base_path)
-        end
-      end
-
-      def parse_hash_item(item_config, base_path, depth:)
-        return file_resolver.build_link_item(item_config) if external_link?(item_config)
-
-        slug = item_config.keys.first
-        options = item_config.values.first
-
-        return file_resolver.resolve(slug, base_path, {}) if options.nil?
-        return parse_nested_item(slug, options, base_path, depth: depth) if options.is_a?(Hash)
-
-        file_resolver.resolve(slug, base_path, options)
-      end
-
-      def external_link?(config)
-        config.key?("link") || config.key?(:link)
-      end
-
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def parse_nested_item(slug, options, base_path, depth:)
-        slug = slug.to_s
-        nested_items = options["items"] || options[:items] || []
-        dir_path = File.join(docs_path, base_path, slug)
-        is_virtual_group = (options["section"] == false || options[:section] == false) && nested_items.any?
-
-        if is_virtual_group
-          build_virtual_group_item(slug, options, nested_items, base_path, depth: depth)
-        elsif File.directory?(dir_path)
-          build_directory_item(slug, options, nested_items, base_path, depth: depth)
-        elsif nested_items.any?
-          build_file_with_children_item(slug, options, nested_items, base_path, depth: depth)
-        else
-          file_resolver.resolve(slug, base_path, options)
-        end
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-      def build_virtual_group_item(slug, options, nested_items, base_path, depth:)
-        common_opts = metadata_extractor.extract_common_options(options)
-        parsed_items = parse_items(nested_items, base_path, depth: depth + 1)
-        is_collapsed = common_opts[:collapsed] != false && !active_child?(parsed_items)
-
-        Item.new(
-          slug: slug,
-          text: common_opts[:text] || Utils::TextFormatter.titleize(slug),
-          path: nil,
-          icon: common_opts[:icon],
-          collapsed: is_collapsed,
-          active: false,
-          items: parsed_items,
-          type: :directory,
-          section: false
-        )
-      end
-
-      def build_directory_item(slug, options, nested_items, base_path, depth:)
-        context = build_directory_context(slug, options, nested_items, base_path, depth)
-        context[:parsed_items] = prepend_intro_if_needed(context, depth)
-        create_directory_item(slug, context, depth)
-      end
-
-      def build_directory_context(slug, options, nested_items, base_path, depth)
-        new_base_path = File.join(base_path, slug)
-        {
-          common_opts: metadata_extractor.extract_common_options(options),
-          parsed_items: resolve_directory_children(nested_items, new_base_path, depth),
-          **build_index_info(new_base_path)
-        }
-      end
-
-      def build_index_info(base_path)
-        index_file_path = File.join(docs_path, base_path, "index.md")
-        has_index = File.file?(index_file_path)
-        url_path = has_index ? Utils::PathResolver.to_url(base_path) : nil
-
-        { index_file_path: index_file_path, has_index: has_index,
-          url_path: url_path, is_active: has_index && current_path == url_path }
-      end
-
-      def resolve_directory_children(nested_items, base_path, depth)
-        return parse_items(nested_items, base_path, depth: depth + 1) if nested_items.any?
-
-        auto_discover_children(base_path, depth: depth + 1)
-      end
-
-      def prepend_intro_if_needed(context, depth)
-        is_section = section_for_depth?(context[:common_opts][:section], depth)
-        return context[:parsed_items] unless is_section && context[:has_index]
-
-        [build_introduction_item(context[:index_file_path], context[:url_path])] + context[:parsed_items]
-      end
-
-      def create_directory_item(slug, context, depth)
-        is_section = section_for_depth?(context[:common_opts][:section], depth)
-        Item.new(
-          slug: slug,
-          text: context[:common_opts][:text] || Utils::TextFormatter.titleize(slug),
-          path: is_section ? nil : context[:url_path],
-          icon: context[:common_opts][:icon],
-          collapsed: is_section ? false : directory_collapsed?(context),
-          active: is_section ? false : context[:is_active],
-          has_index: is_section ? false : context[:has_index],
-          items: context[:parsed_items],
-          type: :directory,
-          section: is_section
-        )
-      end
-
-      def section_for_depth?(explicit_section, depth)
-        return explicit_section unless explicit_section.nil?
-
-        depth == 1
-      end
-
-      def directory_collapsed?(context)
-        return false if context[:is_active] || active_child?(context[:parsed_items])
-
-        context[:common_opts][:collapsed] != false
-      end
-
-      def build_introduction_item(index_file_path, url_path)
-        metadata = metadata_extractor.extract_index_metadata(index_file_path)
-        Item.new(
-          slug: "index", text: metadata[:sidebar_text] || "Overview",
-          path: url_path, icon: metadata[:icon], active: current_path == url_path, type: :file
-        )
-      end
-
-      def build_file_with_children_item(slug, options, nested_items, base_path, depth:)
-        file_resolver.build_file_with_children(
-          slug: slug, options: options, base_path: base_path,
-          parsed_items: parse_items(nested_items, base_path, depth: depth + 1),
-          depth: depth
-        )
-      end
-
-      def auto_discover_children(relative_path, depth:)
-        children_discoverer.discover(relative_path, depth: depth) do |config_or_type, *args|
-          if config_or_type.is_a?(Array)
-            parse_items(config_or_type, args[0], depth: args[1])
-          else
-            build_discovered_item(config_or_type, args[0], args[1], depth)
-          end
-        end
-      end
-
-      def build_discovered_item(type, slug, base_path, depth)
-        if type == :directory
-          build_directory_item(slug, {}, [], base_path, depth: depth)
-        else
-          file_resolver.resolve(slug, base_path)
-        end
-      end
-
-      def active_child?(items)
-        items.any? { |item| item.active || active_child?(item.items) }
-      end
-    end
-  end
-end