docyard 0.9.0 → 1.0.0

data/lib/docyard/utils/git_info.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Docyard
+  module Utils
+    class GitInfo
+      TIME_UNITS = [
+        [60, "minute"],
+        [3600, "hour"],
+        [86_400, "day"],
+        [604_800, "week"],
+        [2_592_000, "month"],
+        [31_536_000, "year"]
+      ].freeze
+
+      class << self
+        attr_accessor :timestamp_cache
+
+        def prefetch_timestamps(docs_path = "docs")
+          return unless git_repository?
+
+          @timestamp_cache = fetch_all_timestamps(docs_path)
+        end
+
+        def clear_cache
+          @timestamp_cache = nil
+        end
+
+        def cached_timestamp(file_path)
+          return nil unless @timestamp_cache
+
+          @timestamp_cache[file_path]
+        end
+
+        def git_repository?
+          File.directory?(".git") || system("git", "rev-parse", "--git-dir", out: File::NULL, err: File::NULL)
+        end
+
+        private
+
+        def fetch_all_timestamps(docs_path)
+          output, _, status = Open3.capture3("git", "log", "--pretty=format:%cI", "--name-only", "--", "#{docs_path}/")
+          return {} unless status.success?
+
+          parse_git_log_output(output)
+        end
+
+        def parse_git_log_output(output)
+          timestamps = {}
+          current_timestamp = nil
+
+          output.each_line do |line|
+            line = line.strip
+            next if line.empty?
+
+            if line.match?(/^\d{4}-\d{2}-\d{2}T/)
+              current_timestamp = Time.parse(line)
+            elsif current_timestamp && !timestamps.key?(line)
+              timestamps[line] = current_timestamp
+            end
+          end
+
+          timestamps
+        end
+      end
+
+      attr_reader :repo_url, :branch, :edit_path
+
+      def initialize(repo_url:, branch: "main", edit_path: "docs")
+        @repo_url = repo_url
+        @branch = branch
+        @edit_path = edit_path
+      end
+
+      def edit_url(file_path)
+        return nil unless repo_url
+
+        relative_path = extract_relative_path(file_path)
+        return nil unless relative_path
+
+        normalized_url = repo_url.chomp("/")
+        "#{normalized_url}/edit/#{branch}/#{edit_path}/#{relative_path}"
+      end
+
+      def last_updated(file_path)
+        return nil unless file_path && File.exist?(file_path)
+        return nil unless self.class.git_repository?
+
+        timestamp = git_last_commit_time(file_path)
+        return nil unless timestamp
+
+        {
+          time: timestamp,
+          iso: timestamp.iso8601,
+          formatted: format_datetime(timestamp),
+          formatted_short: format_date_short(timestamp),
+          relative: relative_time(timestamp)
+        }
+      end
+
+      private
+
+      def extract_relative_path(file_path)
+        return nil unless file_path
+
+        match = file_path.match(%r{#{Regexp.escape(edit_path)}/(.+)$})
+        match ? match[1] : nil
+      end
+
+      def git_last_commit_time(file_path)
+        cached = self.class.cached_timestamp(file_path)
+        return cached if cached
+
+        fetch_single_timestamp(file_path)
+      end
+
+      def fetch_single_timestamp(file_path)
+        output, _, status = Open3.capture3("git", "log", "-1", "--format=%cI", "--", file_path)
+        return nil unless status.success?
+        return nil if output.strip.empty?
+
+        Time.parse(output.strip)
+      rescue ArgumentError
+        nil
+      end
+
+      def format_datetime(time)
+        time.strftime("%B %-d, %Y at %-I:%M %p")
+      end
+
+      def format_date_short(time)
+        time.strftime("%b %-d, %Y")
+      end
+
+      def relative_time(time)
+        seconds = Time.now - time
+        return "just now" if seconds < TIME_UNITS.first.first
+
+        divisor, unit = find_time_unit(seconds)
+        pluralize((seconds / divisor).to_i, unit)
+      end
+
+      def find_time_unit(seconds)
+        TIME_UNITS.reverse_each do |threshold, unit|
+          return [threshold, unit] if seconds >= threshold
+        end
+        TIME_UNITS.first
+      end
+
+      def pluralize(count, word)
+        suffix = count == 1 ? "" : "s"
+        "#{count} #{word}#{suffix} ago"
+      end
+    end
+  end
+end

data/lib/docyard/utils/hash_utils.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Docyard
+  module Utils
+    module HashUtils
+      module_function
+
+      def deep_merge(hash1, hash2)
+        hash1.merge(hash2) do |_key, v1, v2|
+          if v2.nil?
+            v1
+          elsif v1.is_a?(Hash) && v2.is_a?(Hash)
+            deep_merge(v1, v2)
+          else
+            v2
+          end
+        end
+      end
+
+      def deep_dup(hash)
+        hash.transform_values do |value|
+          case value
+          when Hash then deep_dup(value)
+          when Array then value.map { |v| v.is_a?(Hash) ? deep_dup(v) : v }
+          else value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docyard/utils/html_helpers.rb

@@ -3,6 +3,14 @@
 module Docyard
   module Utils
     module HtmlHelpers
+      def escape_html(text)
+        text.to_s
+          .gsub("&", "&")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+          .gsub('"', "&quot;")
+      end
+
       def escape_html_attribute(text)
         text.gsub('"', "&quot;")
           .gsub("'", "&#39;")

data/lib/docyard/utils/logging.rb

@@ -15,6 +15,32 @@ module Docyard
         logger.level = Logger.const_get(level.to_s.upcase)
       end
 
+      def start_buffering
+        @buffered_warnings = []
+        @buffering = true
+      end
+
+      def stop_buffering
+        @buffering = false
+        warnings = @buffered_warnings || []
+        @buffered_warnings = []
+        warnings
+      end
+
+      def buffering?
+        @buffering == true
+      end
+
+      def buffer_warning(message)
+        @buffered_warnings ||= []
+        @buffered_warnings << message
+      end
+
+      def flush_warnings
+        warnings = stop_buffering
+        warnings.each { |msg| logger.warn(msg) }
+      end
+
       private
 
       def default_logger
@@ -25,9 +51,24 @@ module Docyard
       end
 
       def log_formatter
-        proc do |severity, datetime, _progname, msg|
-          timestamp = datetime.strftime("%Y-%m-%d %H:%M:%S")
-          "[#{timestamp}] [Docyard] [#{severity}] #{msg}\n"
+        proc do |severity, _datetime, _progname, msg|
+          if severity == "WARN" && buffering?
+            buffer_warning(msg)
+            nil
+          else
+            format_message(severity, msg)
+          end
+        end
+      end
+
+      def format_message(severity, msg)
+        case severity
+        when "DEBUG"
+          "[DEBUG] #{msg}\n"
+        when "INFO"
+          "#{msg}\n"
+        else
+          "[#{severity}] #{msg}\n"
         end
       end
     end

data/lib/docyard/utils/path_resolver.rb

@@ -16,16 +16,6 @@ module Docyard
         normalized = "/#{normalized}" unless normalized.start_with?("/")
         normalized
       end
-
-      def self.to_url(relative_path)
-        normalize(relative_path)
-      end
-
-      def self.ancestor?(parent_path, child_path)
-        return false if parent_path.nil?
-
-        child_path.start_with?(parent_path) && child_path != parent_path
-      end
     end
   end
 end

data/lib/docyard/utils/path_utils.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Docyard
+  module Utils
+    module PathUtils
+      module_function
+
+      def sanitize_url_path(request_path)
+        decoded = decode_path(request_path)
+        clean = decoded.delete_prefix("/").delete_suffix("/")
+        clean = "index" if clean.empty?
+        clean.delete_suffix(".md")
+      end
+
+      def safe_path?(requested_path, base_dir)
+        return false if requested_path.nil? || base_dir.nil?
+
+        expanded_base = File.expand_path(base_dir)
+        expanded_path = File.expand_path(requested_path, base_dir)
+        expanded_path.start_with?("#{expanded_base}/") || expanded_path == expanded_base
+      end
+
+      def resolve_safe_path(relative_path, base_dir)
+        return nil if relative_path.nil? || base_dir.nil?
+
+        decoded = decode_path(relative_path)
+        full_path = File.join(base_dir, decoded)
+        expanded = File.expand_path(full_path)
+        expanded_base = File.expand_path(base_dir)
+
+        return nil unless expanded.start_with?("#{expanded_base}/")
+
+        expanded
+      end
+
+      def decode_path(path)
+        decoded = URI.decode_www_form_component(path.to_s)
+        decoded.gsub(/\\+/, "/")
+      rescue ArgumentError
+        path.to_s
+      end
+
+      def markdown_file_to_url(file_path, docs_path)
+        relative_path = file_path.delete_prefix("#{docs_path}/")
+        relative_path_to_url(relative_path)
+      end
+
+      def relative_path_to_url(relative_path)
+        base_name = File.basename(relative_path, ".md")
+        dir_name = File.dirname(relative_path)
+
+        if base_name == "index"
+          dir_name == "." ? "/" : "/#{dir_name}"
+        else
+          dir_name == "." ? "/#{base_name}" : "/#{dir_name}/#{base_name}"
+        end
+      end
+
+      def markdown_to_html_output(relative_path, output_dir)
+        base_name = File.basename(relative_path, ".md")
+        dir_name = File.dirname(relative_path)
+
+        if base_name == "index"
+          File.join(output_dir, dir_name, "index.html")
+        else
+          File.join(output_dir, dir_name, base_name, "index.html")
+        end
+      end
+    end
+  end
+end

data/lib/docyard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docyard
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/docyard.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "docyard/version"
-require_relative "docyard/config/constants"
-require_relative "docyard/utils/errors"
+require_relative "docyard/constants"
+require_relative "docyard/errors"
 require_relative "docyard/utils/logging"
 
 require_relative "docyard/utils/text_formatter"

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sanif Himani
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cssminify
@@ -79,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -149,42 +178,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: webrick
-  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'
 description: Beautiful, zero-config documentation sites. Built with Ruby.
 email:
 - sanifhimani92@gmail.com
-executables: []
+executables:
+- docyard
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/pull_request_template.md"
-- ".github/workflows/ci.yml"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - LICENSE.txt
-- LICENSE.vscode-icons
 - README.md
-- Rakefile
+- exe/docyard
 - lib/docyard.rb
 - lib/docyard/build/asset_bundler.rb
 - lib/docyard/build/file_copier.rb
+- lib/docyard/build/llms_txt_generator.rb
 - lib/docyard/build/sitemap_generator.rb
 - lib/docyard/build/static_generator.rb
 - lib/docyard/builder.rb
@@ -197,6 +206,8 @@ files:
 - lib/docyard/components/processors/callout_processor.rb
 - lib/docyard/components/processors/cards_processor.rb
 - lib/docyard/components/processors/code_block_diff_preprocessor.rb
+- lib/docyard/components/processors/code_block_extended_fence_postprocessor.rb
+- lib/docyard/components/processors/code_block_extended_fence_preprocessor.rb
 - lib/docyard/components/processors/code_block_focus_preprocessor.rb
 - lib/docyard/components/processors/code_block_options_preprocessor.rb
 - lib/docyard/components/processors/code_block_processor.rb
@@ -217,6 +228,7 @@ files:
 - lib/docyard/components/registry.rb
 - lib/docyard/components/support/code_block/feature_extractor.rb
 - lib/docyard/components/support/code_block/icon_detector.rb
+- lib/docyard/components/support/code_block/line_number_resolver.rb
 - lib/docyard/components/support/code_block/line_parser.rb
 - lib/docyard/components/support/code_block/line_wrapper.rb
 - lib/docyard/components/support/code_block/patterns.rb
@@ -227,35 +239,37 @@ files:
 - lib/docyard/components/support/tabs/parser.rb
 - lib/docyard/components/support/tabs/range_finder.rb
 - lib/docyard/config.rb
+- lib/docyard/config/analytics_resolver.rb
 - lib/docyard/config/branding_resolver.rb
-- lib/docyard/config/constants.rb
+- lib/docyard/config/key_validator.rb
 - lib/docyard/config/logo_detector.rb
+- lib/docyard/config/schema.rb
+- lib/docyard/config/section.rb
+- lib/docyard/config/validation_helpers.rb
 - lib/docyard/config/validator.rb
+- lib/docyard/config/validators/navigation.rb
+- lib/docyard/config/validators/section.rb
+- lib/docyard/constants.rb
+- lib/docyard/errors.rb
 - lib/docyard/initializer.rb
 - lib/docyard/navigation/breadcrumb_builder.rb
+- lib/docyard/navigation/page_navigation_builder.rb
 - lib/docyard/navigation/prev_next_builder.rb
-- lib/docyard/navigation/sidebar/children_discoverer.rb
-- lib/docyard/navigation/sidebar/config_parser.rb
-- lib/docyard/navigation/sidebar/file_resolver.rb
-- lib/docyard/navigation/sidebar/file_system_scanner.rb
+- lib/docyard/navigation/sidebar/auto_builder.rb
+- lib/docyard/navigation/sidebar/cache.rb
+- lib/docyard/navigation/sidebar/config_builder.rb
+- lib/docyard/navigation/sidebar/distributed_builder.rb
 - lib/docyard/navigation/sidebar/item.rb
 - lib/docyard/navigation/sidebar/local_config_loader.rb
-- lib/docyard/navigation/sidebar/metadata_extractor.rb
-- lib/docyard/navigation/sidebar/metadata_reader.rb
-- lib/docyard/navigation/sidebar/path_prefixer.rb
 - lib/docyard/navigation/sidebar/renderer.rb
-- lib/docyard/navigation/sidebar/sorter.rb
-- lib/docyard/navigation/sidebar/title_extractor.rb
-- lib/docyard/navigation/sidebar/tree_builder.rb
 - lib/docyard/navigation/sidebar/tree_filter.rb
 - lib/docyard/navigation/sidebar_builder.rb
+- lib/docyard/rendering/branding_variables.rb
 - lib/docyard/rendering/icon_helpers.rb
 - lib/docyard/rendering/icons.rb
-- lib/docyard/rendering/icons/LICENSE.phosphor
-- lib/docyard/rendering/icons/file_types.rb
-- lib/docyard/rendering/icons/phosphor.rb
-- lib/docyard/rendering/language_mapping.rb
+- lib/docyard/rendering/icons/devicons.rb
 - lib/docyard/rendering/markdown.rb
+- lib/docyard/rendering/og_helpers.rb
 - lib/docyard/rendering/renderer.rb
 - lib/docyard/rendering/template_resolver.rb
 - lib/docyard/routing/fallback_resolver.rb
@@ -270,6 +284,8 @@ files:
 - lib/docyard/server/rack_application.rb
 - lib/docyard/server/resolution_result.rb
 - lib/docyard/server/router.rb
+- lib/docyard/server/sse_server.rb
+- lib/docyard/server/static_file_app.rb
 - lib/docyard/templates/assets/css/code.css
 - lib/docyard/templates/assets/css/components/abbreviation.css
 - lib/docyard/templates/assets/css/components/accordion.css
@@ -280,6 +296,7 @@ files:
 - lib/docyard/templates/assets/css/components/cards.css
 - lib/docyard/templates/assets/css/components/code-block.css
 - lib/docyard/templates/assets/css/components/code-group.css
+- lib/docyard/templates/assets/css/components/feedback.css
 - lib/docyard/templates/assets/css/components/figure.css
 - lib/docyard/templates/assets/css/components/file-tree.css
 - lib/docyard/templates/assets/css/components/heading-anchor.css
@@ -288,6 +305,7 @@ files:
 - lib/docyard/templates/assets/css/components/logo.css
 - lib/docyard/templates/assets/css/components/nav-menu.css
 - lib/docyard/templates/assets/css/components/navigation.css
+- lib/docyard/templates/assets/css/components/page-actions.css
 - lib/docyard/templates/assets/css/components/prev-next.css
 - lib/docyard/templates/assets/css/components/search.css
 - lib/docyard/templates/assets/css/components/steps.css
@@ -310,6 +328,8 @@ files:
 - lib/docyard/templates/assets/js/components/banner.js
 - lib/docyard/templates/assets/js/components/code-block.js
 - lib/docyard/templates/assets/js/components/code-group.js
+- lib/docyard/templates/assets/js/components/copy-page.js
+- lib/docyard/templates/assets/js/components/feedback.js
 - lib/docyard/templates/assets/js/components/file-tree.js
 - lib/docyard/templates/assets/js/components/heading-anchor.js
 - lib/docyard/templates/assets/js/components/lightbox.js
@@ -320,16 +340,22 @@ files:
 - lib/docyard/templates/assets/js/components/table-of-contents.js
 - lib/docyard/templates/assets/js/components/tabs.js
 - lib/docyard/templates/assets/js/components/tooltip.js
-- lib/docyard/templates/assets/js/reload.js
+- lib/docyard/templates/assets/js/hot-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/init/_sidebar.yml
+- lib/docyard/templates/init/docyard.yml
+- lib/docyard/templates/init/pages/components.md
+- lib/docyard/templates/init/pages/getting-started.md
+- lib/docyard/templates/init/pages/index.md
 - lib/docyard/templates/layouts/default.html.erb
 - lib/docyard/templates/layouts/splash.html.erb
 - lib/docyard/templates/partials/_accordion.html.erb
+- lib/docyard/templates/partials/_analytics.html.erb
 - lib/docyard/templates/partials/_banner.html.erb
 - lib/docyard/templates/partials/_breadcrumbs.html.erb
 - lib/docyard/templates/partials/_callout.html.erb
@@ -337,13 +363,13 @@ files:
 - lib/docyard/templates/partials/_code_block.html.erb
 - lib/docyard/templates/partials/_doc_footer.html.erb
 - lib/docyard/templates/partials/_features.html.erb
+- lib/docyard/templates/partials/_feedback.html.erb
 - lib/docyard/templates/partials/_footer.html.erb
 - lib/docyard/templates/partials/_head.html.erb
 - lib/docyard/templates/partials/_header.html.erb
 - lib/docyard/templates/partials/_heading_anchor.html.erb
 - lib/docyard/templates/partials/_hero.html.erb
-- lib/docyard/templates/partials/_icon.html.erb
-- lib/docyard/templates/partials/_icon_file_extension.html.erb
+- lib/docyard/templates/partials/_icon_library.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
@@ -351,6 +377,7 @@ files:
 - lib/docyard/templates/partials/_nav_menu.html.erb
 - lib/docyard/templates/partials/_nav_nested_section.html.erb
 - lib/docyard/templates/partials/_nav_section.html.erb
+- lib/docyard/templates/partials/_page_actions.html.erb
 - lib/docyard/templates/partials/_prev_next.html.erb
 - lib/docyard/templates/partials/_scripts.html.erb
 - lib/docyard/templates/partials/_search_modal.html.erb
@@ -363,14 +390,15 @@ files:
 - lib/docyard/templates/partials/_table_of_contents_toggle.html.erb
 - lib/docyard/templates/partials/_tabs.html.erb
 - lib/docyard/templates/partials/_theme_toggle.html.erb
-- lib/docyard/utils/errors.rb
+- lib/docyard/utils/git_info.rb
+- lib/docyard/utils/hash_utils.rb
 - lib/docyard/utils/html_helpers.rb
 - lib/docyard/utils/logging.rb
 - lib/docyard/utils/path_resolver.rb
+- lib/docyard/utils/path_utils.rb
 - lib/docyard/utils/text_formatter.rb
 - lib/docyard/utils/url_helpers.rb
 - lib/docyard/version.rb
-- sig/docyard.rbs
 homepage: https://github.com/sanifhimani/docyard
 licenses:
 - MIT
@@ -379,6 +407,7 @@ metadata:
   homepage_uri: https://github.com/sanifhimani/docyard
   source_code_uri: https://github.com/sanifhimani/docyard
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -393,7 +422,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Documentation generator for Ruby
 test_files: []

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +0,0 @@
----
-name: Bug Report
-about: Report a bug
-title: ''
-labels: bug
-assignees: ''
----
-
-## Description
-
-<!-- Clear description of the bug -->
-
-## Steps to Reproduce
-
-1.
-2.
-3.
-
-## Expected Behavior
-
-<!-- What should happen -->
-
-## Actual Behavior
-
-<!-- What actually happens -->
-
-## Environment
-
-- Ruby version: <!-- `ruby -v` -->
-- Docyard version: <!-- `gem list docyard` -->
-- OS: <!-- macOS, Linux, etc. -->