RubyGems - docyard - Versions diffs - 0.9.0 → 1.0.1 - Mend

docyard 0.9.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (165) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +57 -1
data/README.md +8 -253
data/exe/docyard +6 -0
data/lib/docyard/build/asset_bundler.rb +24 -2
data/lib/docyard/build/error_page_generator.rb +33 -0
data/lib/docyard/build/file_copier.rb +12 -5
data/lib/docyard/build/file_writer.rb +19 -0
data/lib/docyard/build/llms_txt_generator.rb +103 -0
data/lib/docyard/build/root_fallback_generator.rb +66 -0
data/lib/docyard/build/sitemap_generator.rb +1 -1
data/lib/docyard/build/static_generator.rb +119 -81
data/lib/docyard/builder.rb +6 -2
data/lib/docyard/cli.rb +14 -4
data/lib/docyard/components/processors/callout_processor.rb +1 -1
data/lib/docyard/components/processors/code_block_extended_fence_postprocessor.rb +24 -0
data/lib/docyard/components/processors/code_block_extended_fence_preprocessor.rb +44 -0
data/lib/docyard/components/processors/code_block_options_preprocessor.rb +11 -1
data/lib/docyard/components/processors/code_block_processor.rb +5 -24
data/lib/docyard/components/processors/code_group_processor.rb +6 -22
data/lib/docyard/components/processors/code_snippet_import_preprocessor.rb +1 -0
data/lib/docyard/components/processors/file_tree_processor.rb +1 -2
data/lib/docyard/components/processors/icon_processor.rb +8 -2
data/lib/docyard/components/processors/include_processor.rb +10 -10
data/lib/docyard/components/processors/video_embed_processor.rb +14 -3
data/lib/docyard/components/support/code_block/feature_extractor.rb +3 -1
data/lib/docyard/components/support/code_block/icon_detector.rb +5 -12
data/lib/docyard/components/support/code_block/line_number_resolver.rb +30 -0
data/lib/docyard/components/support/code_detector.rb +2 -12
data/lib/docyard/components/support/code_group/html_builder.rb +2 -6
data/lib/docyard/components/support/tabs/icon_detector.rb +6 -2
data/lib/docyard/components/support/tabs/parser.rb +6 -23
data/lib/docyard/config/analytics_resolver.rb +24 -0
data/lib/docyard/config/branding_resolver.rb +58 -27
data/lib/docyard/config/key_validator.rb +30 -0
data/lib/docyard/config/logo_detector.rb +8 -8
data/lib/docyard/config/schema.rb +39 -0
data/lib/docyard/config/section.rb +21 -0
data/lib/docyard/config/validation_helpers.rb +83 -0
data/lib/docyard/config/validator.rb +45 -144
data/lib/docyard/config/validators/navigation.rb +43 -0
data/lib/docyard/config/validators/section.rb +114 -0
data/lib/docyard/config.rb +46 -102
data/lib/docyard/constants.rb +59 -0
data/lib/docyard/{utils/errors.rb → errors.rb} +6 -0
data/lib/docyard/initializer.rb +100 -49
data/lib/docyard/navigation/breadcrumb_builder.rb +45 -6
data/lib/docyard/navigation/page_navigation_builder.rb +65 -0
data/lib/docyard/navigation/sidebar/auto_builder.rb +107 -0
data/lib/docyard/navigation/sidebar/cache.rb +96 -0
data/lib/docyard/navigation/sidebar/config_builder.rb +179 -0
data/lib/docyard/navigation/sidebar/distributed_builder.rb +145 -0
data/lib/docyard/navigation/sidebar/local_config_loader.rb +69 -3
data/lib/docyard/navigation/sidebar/renderer.rb +12 -1
data/lib/docyard/navigation/sidebar_builder.rb +43 -81
data/lib/docyard/rendering/branding_variables.rb +65 -0
data/lib/docyard/rendering/icon_helpers.rb +14 -1
data/lib/docyard/rendering/icons/devicons.rb +63 -0
data/lib/docyard/rendering/icons.rb +26 -27
data/lib/docyard/rendering/markdown.rb +5 -23
data/lib/docyard/rendering/og_helpers.rb +36 -0
data/lib/docyard/rendering/renderer.rb +96 -61
data/lib/docyard/rendering/template_resolver.rb +14 -0
data/lib/docyard/routing/fallback_resolver.rb +3 -3
data/lib/docyard/search/build_indexer.rb +2 -2
data/lib/docyard/search/dev_indexer.rb +36 -28
data/lib/docyard/search/pagefind_support.rb +1 -1
data/lib/docyard/server/asset_handler.rb +39 -15
data/lib/docyard/server/dev_server.rb +90 -55
data/lib/docyard/server/file_watcher.rb +68 -18
data/lib/docyard/server/pagefind_handler.rb +1 -1
data/lib/docyard/server/preview_server.rb +29 -33
data/lib/docyard/server/rack_application.rb +39 -71
data/lib/docyard/server/router.rb +11 -7
data/lib/docyard/server/sse_server.rb +157 -0
data/lib/docyard/server/static_file_app.rb +42 -0
data/lib/docyard/templates/assets/css/components/banner.css +31 -0
data/lib/docyard/templates/assets/css/components/breadcrumbs.css +2 -1
data/lib/docyard/templates/assets/css/components/callout.css +26 -6
data/lib/docyard/templates/assets/css/components/code-block.css +4 -2
data/lib/docyard/templates/assets/css/components/code-group.css +20 -7
data/lib/docyard/templates/assets/css/components/feedback.css +126 -0
data/lib/docyard/templates/assets/css/components/file-tree.css +5 -4
data/lib/docyard/templates/assets/css/components/heading-anchor.css +2 -2
data/lib/docyard/templates/assets/css/components/icon.css +5 -0
data/lib/docyard/templates/assets/css/components/nav-menu.css +20 -4
data/lib/docyard/templates/assets/css/components/navigation.css +25 -3
data/lib/docyard/templates/assets/css/components/page-actions.css +131 -0
data/lib/docyard/templates/assets/css/components/prev-next.css +14 -7
data/lib/docyard/templates/assets/css/components/search.css +6 -10
data/lib/docyard/templates/assets/css/components/tab-bar.css +9 -6
data/lib/docyard/templates/assets/css/components/table-of-contents.css +63 -17
data/lib/docyard/templates/assets/css/components/tabs.css +12 -4
data/lib/docyard/templates/assets/css/components/theme-toggle.css +3 -1
data/lib/docyard/templates/assets/css/landing.css +82 -13
data/lib/docyard/templates/assets/css/layout.css +32 -16
data/lib/docyard/templates/assets/css/markdown.css +22 -2
data/lib/docyard/templates/assets/css/variables.css +14 -1
data/lib/docyard/templates/assets/js/components/code-group.js +4 -1
data/lib/docyard/templates/assets/js/components/copy-page.js +115 -0
data/lib/docyard/templates/assets/js/components/feedback.js +66 -0
data/lib/docyard/templates/assets/js/components/file-tree.js +5 -5
data/lib/docyard/templates/assets/js/components/navigation.js +3 -3
data/lib/docyard/templates/assets/js/components/search.js +3 -3
data/lib/docyard/templates/assets/js/components/table-of-contents.js +12 -6
data/lib/docyard/templates/assets/js/components/tabs.js +45 -22
data/lib/docyard/templates/assets/js/components/tooltip.js +4 -4
data/lib/docyard/templates/assets/js/hot-reload.js +44 -0
data/lib/docyard/templates/errors/404.html.erb +125 -5
data/lib/docyard/templates/errors/500.html.erb +184 -10
data/lib/docyard/templates/errors/redirect.html.erb +12 -0
data/lib/docyard/templates/init/_sidebar.yml +36 -0
data/lib/docyard/templates/init/docyard.yml +36 -0
data/lib/docyard/templates/init/pages/components.md +146 -0
data/lib/docyard/templates/init/pages/getting-started.md +94 -0
data/lib/docyard/templates/init/pages/index.md +22 -0
data/lib/docyard/templates/layouts/default.html.erb +10 -0
data/lib/docyard/templates/layouts/splash.html.erb +14 -1
data/lib/docyard/templates/partials/_analytics.html.erb +24 -0
data/lib/docyard/templates/partials/_banner.html.erb +1 -1
data/lib/docyard/templates/partials/_code_block.html.erb +1 -1
data/lib/docyard/templates/partials/_feedback.html.erb +14 -0
data/lib/docyard/templates/partials/_footer.html.erb +1 -1
data/lib/docyard/templates/partials/_head.html.erb +80 -5
data/lib/docyard/templates/partials/_icon_library.html.erb +8 -0
data/lib/docyard/templates/partials/_page_actions.html.erb +21 -0
data/lib/docyard/templates/partials/_scripts.html.erb +6 -3
data/lib/docyard/templates/partials/_tabs.html.erb +4 -1
data/lib/docyard/utils/git_info.rb +157 -0
data/lib/docyard/utils/hash_utils.rb +31 -0
data/lib/docyard/utils/html_helpers.rb +8 -0
data/lib/docyard/utils/logging.rb +44 -3
data/lib/docyard/utils/path_resolver.rb +0 -10
data/lib/docyard/utils/path_utils.rb +73 -0
data/lib/docyard/version.rb +1 -1
data/lib/docyard.rb +2 -2
metadata +81 -47
data/.github/ISSUE_TEMPLATE/bug_report.md +0 -31
data/.github/ISSUE_TEMPLATE/feature_request.md +0 -19
data/.github/pull_request_template.md +0 -14
data/.github/workflows/ci.yml +0 -49
data/.rubocop.yml +0 -42
data/CODE_OF_CONDUCT.md +0 -132
data/CONTRIBUTING.md +0 -55
data/LICENSE.vscode-icons +0 -42
data/Rakefile +0 -8
data/lib/docyard/config/constants.rb +0 -31
data/lib/docyard/navigation/sidebar/children_discoverer.rb +0 -51
data/lib/docyard/navigation/sidebar/config_parser.rb +0 -208
data/lib/docyard/navigation/sidebar/file_resolver.rb +0 -90
data/lib/docyard/navigation/sidebar/file_system_scanner.rb +0 -78
data/lib/docyard/navigation/sidebar/metadata_extractor.rb +0 -71
data/lib/docyard/navigation/sidebar/metadata_reader.rb +0 -51
data/lib/docyard/navigation/sidebar/path_prefixer.rb +0 -34
data/lib/docyard/navigation/sidebar/sorter.rb +0 -21
data/lib/docyard/navigation/sidebar/title_extractor.rb +0 -25
data/lib/docyard/navigation/sidebar/tree_builder.rb +0 -140
data/lib/docyard/rendering/icons/LICENSE.phosphor +0 -21
data/lib/docyard/rendering/icons/file_types.rb +0 -79
data/lib/docyard/rendering/icons/phosphor.rb +0 -93
data/lib/docyard/rendering/language_mapping.rb +0 -52
data/lib/docyard/templates/assets/js/reload.js +0 -98
data/lib/docyard/templates/partials/_icon.html.erb +0 -1
data/lib/docyard/templates/partials/_icon_file_extension.html.erb +0 -1
data/sig/docyard.rbs +0 -4

data/lib/docyard/rendering/renderer.rb CHANGED Viewed

@@ -1,82 +1,142 @@
 # frozen_string_literal: true
 require "erb"
-require_relative "../config/constants"
+require_relative "../constants"
+require_relative "../utils/git_info"
 require_relative "icon_helpers"
+require_relative "og_helpers"
+require_relative "branding_variables"
 module Docyard
   class Renderer
     include Utils::UrlHelpers
+    include Utils::HtmlHelpers
     include IconHelpers
+    include OgHelpers
+    include BrandingVariables
     LAYOUTS_PATH = File.join(__dir__, "../templates", "layouts")
     ERRORS_PATH = File.join(__dir__, "../templates", "errors")
     PARTIALS_PATH = File.join(__dir__, "../templates", "partials")
     DEFAULT_LAYOUT = "default"
-    attr_reader :base_url, :config
+    attr_reader :base_url, :config, :dev_mode, :sse_port
-    def initialize(base_url: "/", config: nil)
+    def initialize(base_url: "/", config: nil, dev_mode: false, sse_port: nil)
       @base_url = normalize_base_url(base_url)
       @config = config
+      @dev_mode = dev_mode
+      @sse_port = sse_port
     end
     def render_file(file_path, sidebar_html: "", prev_next_html: "", breadcrumbs: nil, branding: {},
                     template_options: {}, current_path: "/")
-      markdown = Markdown.new(File.read(file_path), config: config, file_path: file_path)
+      raw_content = File.read(file_path)
+      markdown = Markdown.new(raw_content, config: config, file_path: file_path)
       render(
         content: strip_md_from_links(markdown.html),
         page_title: markdown.title || Constants::DEFAULT_SITE_TITLE,
+        page_description: markdown.description,
+        page_og_image: markdown.og_image,
         navigation: build_navigation(sidebar_html, prev_next_html, markdown.toc, breadcrumbs),
         branding: branding,
         template_options: template_options,
-        current_path: current_path
+        current_path: current_path,
+        file_path: file_path,
+        raw_markdown: raw_content
       )
     end
+    def render_for_search(file_path)
+      markdown = Markdown.new(File.read(file_path), config: config, file_path: file_path)
+      title = markdown.title || Constants::DEFAULT_SITE_TITLE
+      content = strip_md_from_links(markdown.html)
+      <<~HTML
+        <!DOCTYPE html>
+        <html>
+        <head><title>#{escape_html(title)}</title></head>
+        <body><main data-pagefind-body>#{content}</main></body>
+        </html>
+      HTML
+    end
     def build_navigation(sidebar_html, prev_next_html, toc, breadcrumbs)
       { sidebar_html: sidebar_html, prev_next_html: prev_next_html, toc: toc, breadcrumbs: breadcrumbs }
     end
-    def render(content:, page_title: Constants::DEFAULT_SITE_TITLE, navigation: {}, branding: {},
-               template_options: {}, current_path: "/")
+    def render(content:, page_title: Constants::DEFAULT_SITE_TITLE, page_description: nil, page_og_image: nil,
+               navigation: {}, branding: {}, template_options: {}, current_path: "/", file_path: nil,
+               raw_markdown: nil)
       layout = template_options[:template] || DEFAULT_LAYOUT
       layout_path = File.join(LAYOUTS_PATH, "#{layout}.html.erb")
       template = File.read(layout_path)
-      assign_content_variables(content, page_title, navigation)
+      assign_content_variables(content, page_title, navigation, raw_markdown)
       assign_branding_variables(branding, current_path)
+      assign_og_variables(branding, page_description, page_og_image, current_path)
       assign_template_variables(template_options)
+      assign_git_info(branding, file_path)
+      assign_feedback_variables
       ERB.new(template).result(binding)
     end
-    def render_not_found
+    def render_not_found(branding: nil)
+      @primary_color = branding&.dig(:primary_color)
       render_error_template(404)
     end
-    def render_server_error(error)
+    def render_server_error(error, branding: nil)
       @error_message = error.message
-      @backtrace = error.backtrace.join("\n")
+      @backtrace = error.backtrace&.join("\n") || "No backtrace available"
+      @primary_color = branding&.dig(:primary_color)
       render_error_template(500)
     end
+    def render_redirect(target_url)
+      @target_url = target_url
+      render_error_template(:redirect)
+    end
     def render_error_template(status)
       error_template_path = File.join(ERRORS_PATH, "#{status}.html.erb")
       template = File.read(error_template_path)
       ERB.new(template).result(binding)
     end
+    VALID_IVAR_PATTERN = /\A[a-z_][a-z0-9_]*\z/i
     def render_partial(name, locals = {})
       partial_path = File.join(PARTIALS_PATH, "#{name}.html.erb")
       template = File.read(partial_path)
-      locals.each { |key, value| instance_variable_set("@#{key}", value) }
+      locals.each do |key, value|
+        validate_variable_name!(key)
+        instance_variable_set("@#{key}", value)
+      end
       ERB.new(template).result(binding)
     end
+    def render_custom_visual(file_path)
+      return "" if file_path.nil? || file_path.empty?
+      source_dir = config&.source || "docs"
+      full_path = File.join(source_dir, file_path)
+      return "" unless File.exist?(full_path)
+      File.read(full_path)
+    end
+    def validate_variable_name!(name)
+      return if name.to_s.match?(VALID_IVAR_PATTERN)
+      raise ArgumentError, "Invalid variable name: #{name}"
+    end
     def asset_path(path)
       return path if path.nil? || path.start_with?("http://", "https://")
@@ -85,61 +145,14 @@ module Docyard
     private
-    def assign_content_variables(content, page_title, navigation)
+    def assign_content_variables(content, page_title, navigation, raw_markdown)
       @content = content
       @page_title = page_title
       @sidebar_html = navigation[:sidebar_html] || ""
       @prev_next_html = navigation[:prev_next_html] || ""
       @toc = navigation[:toc] || []
       @breadcrumbs = navigation[:breadcrumbs]
-    end
-    def assign_branding_variables(branding, current_path = "/")
-      assign_site_branding(branding)
-      assign_search_options(branding)
-      assign_credits_and_social(branding)
-      assign_tabs(branding, current_path)
-    end
-    def assign_site_branding(branding)
-      @site_title = branding[:site_title] || Constants::DEFAULT_SITE_TITLE
-      @site_description = branding[:site_description] || ""
-      @logo = branding[:logo] || Constants::DEFAULT_LOGO_PATH
-      @logo_dark = branding[:logo_dark]
-      @favicon = branding[:favicon] || Constants::DEFAULT_FAVICON_PATH
-      @has_custom_logo = branding[:has_custom_logo] || false
-    end
-    def assign_search_options(branding)
-      @search_enabled = branding[:search_enabled].nil? || branding[:search_enabled]
-      @search_placeholder = branding[:search_placeholder] || "Search documentation..."
-    end
-    def assign_credits_and_social(branding)
-      @credits = branding[:credits] != false
-      @copyright = branding[:copyright]
-      @social = branding[:social] || []
-      @header_ctas = branding[:header_ctas] || []
-      @announcement = branding[:announcement]
-    end
-    def assign_tabs(branding, current_path)
-      tabs = branding[:tabs] || []
-      @tabs = tabs.map { |tab| tab.merge(active: tab_active?(tab[:href], current_path)) }
-      @has_tabs = branding[:has_tabs] || false
-      @current_path = current_path
-    end
-    def tab_active?(tab_href, current_path)
-      return false if tab_href.nil? || current_path.nil?
-      return false if tab_href.start_with?("http://", "https://")
-      normalized_tab = tab_href.chomp("/")
-      normalized_current = current_path.chomp("/")
-      return true if normalized_tab == normalized_current
-      current_path.start_with?("#{normalized_tab}/")
+      @raw_markdown = raw_markdown
     end
     def assign_template_variables(template_options)
@@ -160,5 +173,27 @@ module Docyard
     def strip_md_from_links(html)
       html.gsub(/href="([^"]+)\.md"/, 'href="\1"')
     end
+    def assign_git_info(branding, file_path)
+      @show_edit_link = branding[:show_edit_link] && file_path
+      @show_last_updated = branding[:show_last_updated] && file_path
+      return unless @show_edit_link || @show_last_updated
+      git_info = Utils::GitInfo.new(
+        repo_url: branding[:repo_url],
+        branch: branding[:repo_branch],
+        edit_path: branding[:repo_edit_path]
+      )
+      @edit_url = git_info.edit_url(file_path) if @show_edit_link
+      @last_updated = git_info.last_updated(file_path) if @show_last_updated
+    end
+    def assign_feedback_variables
+      return unless config
+      @feedback_enabled = config.feedback.enabled
+      @feedback_question = config.feedback.question
+    end
   end
 end

data/lib/docyard/rendering/template_resolver.rb CHANGED Viewed

@@ -117,6 +117,7 @@ module Docyard
         tagline: hero["tagline"],
         gradient: hero.fetch("gradient", true),
         image: symbolize_image(hero["image"]),
+        custom_visual: symbolize_custom_visual(hero["custom_visual"]),
         actions: symbolize_actions(hero["actions"])
       }.compact
     end
@@ -138,6 +139,19 @@ module Docyard
       end
     end
+    def symbolize_custom_visual(custom_visual)
+      return nil if custom_visual.nil?
+      if custom_visual.is_a?(String)
+        { html: custom_visual, placement: "side" }
+      elsif custom_visual.is_a?(Hash)
+        {
+          html: custom_visual["html"],
+          placement: custom_visual["placement"] || "side"
+        }
+      end
+    end
     def symbolize_actions(actions)
       return nil unless actions.is_a?(Array)

data/lib/docyard/routing/fallback_resolver.rb CHANGED Viewed

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require_relative "../utils/path_utils"
 module Docyard
   module Routing
     class FallbackResolver
@@ -29,9 +31,7 @@ module Docyard
       end
       def sanitize_path(request_path)
-        clean = request_path.to_s.delete_prefix("/").delete_suffix("/")
-        clean = "index" if clean.empty?
-        clean.delete_suffix(".md")
+        Utils::PathUtils.sanitize_url_path(request_path)
       end
       def find_first_item_in_section(request_path)

data/lib/docyard/search/build_indexer.rb CHANGED Viewed

@@ -63,11 +63,11 @@ module Docyard
       end
       def log(message)
-        puts message
+        Docyard.logger.info(message)
       end
       def log_warning(message)
-        warn message
+        Docyard.logger.warn(message)
       end
     end
   end

data/lib/docyard/search/dev_indexer.rb CHANGED Viewed

@@ -3,13 +3,17 @@
 require "fileutils"
 require "tmpdir"
 require "open3"
+require "parallel"
 require "tty-progressbar"
+require_relative "../utils/path_utils"
 module Docyard
   module Search
     class DevIndexer
       include PagefindSupport
+      PARALLEL_THRESHOLD = 10
       attr_reader :docs_path, :config, :temp_dir, :pagefind_path
       def initialize(docs_path:, config:)
@@ -26,12 +30,12 @@ module Docyard
         @temp_dir = Dir.mktmpdir("docyard-search-")
         generate_html_files
         page_count = run_pagefind
-        @pagefind_path = File.join(temp_dir, "pagefind")
+        @pagefind_path = File.join(temp_dir, "_docyard", "pagefind")
         log_success(page_count)
         pagefind_path
       rescue StandardError => e
-        warn "[!] Search index generation failed: #{e.message}"
+        Docyard.logger.warn("Search index generation failed: #{e.message}")
         cleanup
         nil
       end
@@ -46,7 +50,7 @@ module Docyard
       def pagefind_available?
         result = super
-        warn "[!] Search disabled: Pagefind not found (npm install -g pagefind)" unless result
+        Docyard.logger.warn("Search disabled: Pagefind not found (npm install -g pagefind)") unless result
         result
       end
@@ -54,20 +58,43 @@ module Docyard
         markdown_files = Dir.glob(File.join(docs_path, "**", "*.md"))
         markdown_files = filter_excluded_files(markdown_files)
         markdown_files = filter_non_indexable_files(markdown_files)
-        renderer = Renderer.new(base_url: "/", config: config)
         progress = TTY::ProgressBar.new(
           "Indexing search [:bar] :current/:total (:percent)",
           total: markdown_files.size,
           width: 50
         )
+        mutex = Mutex.new
+        Logging.start_buffering
+        if markdown_files.size >= PARALLEL_THRESHOLD
+          generate_files_in_parallel(markdown_files, progress, mutex)
+        else
+          generate_files_sequentially(markdown_files, progress)
+        end
+        Logging.flush_warnings
+      end
+      def generate_files_in_parallel(markdown_files, progress, mutex)
+        Parallel.each(markdown_files, in_threads: Parallel.processor_count) do |file_path|
+          renderer = thread_local_renderer
+          generate_html_file(file_path, renderer)
+          mutex.synchronize { progress.advance }
+        end
+      end
+      def generate_files_sequentially(markdown_files, progress)
+        renderer = Renderer.new(base_url: "/", config: config)
         markdown_files.each do |file_path|
           generate_html_file(file_path, renderer)
           progress.advance
         end
       end
+      def thread_local_renderer
+        Thread.current[:docyard_search_renderer] ||= Renderer.new(base_url: "/", config: config)
+      end
       def filter_excluded_files(files)
         exclude_patterns = config.search.exclude || []
         return files if exclude_patterns.empty?
@@ -96,40 +123,21 @@ module Docyard
       end
       def file_to_url_path(file_path)
-        relative_path = file_path.delete_prefix("#{docs_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
+        Utils::PathUtils.markdown_file_to_url(file_path, docs_path)
       end
       def generate_html_file(markdown_file, renderer)
         relative_path = markdown_file.delete_prefix("#{docs_path}/")
         output_path = determine_output_path(relative_path)
-        html = renderer.render_file(markdown_file, branding: branding_options)
+        html = renderer.render_for_search(markdown_file)
         FileUtils.mkdir_p(File.dirname(output_path))
         File.write(output_path, html)
       end
       def determine_output_path(relative_path)
-        base_name = File.basename(relative_path, ".md")
-        dir_name = File.dirname(relative_path)
-        if base_name == "index"
-          File.join(temp_dir, dir_name, "index.html")
-        else
-          File.join(temp_dir, dir_name, base_name, "index.html")
-        end
-      end
-      def branding_options
-        BrandingResolver.new(config).resolve
+        Utils::PathUtils.markdown_to_html_output(relative_path, temp_dir)
       end
       def run_pagefind
@@ -147,8 +155,8 @@ module Docyard
       end
       def log_success(page_count)
-        puts "=> Search index generated (#{page_count} pages indexed)"
-        puts "=> Temp directory: #{temp_dir}" if ENV["DOCYARD_DEBUG"]
+        Docyard.logger.info("* Search index generated (#{page_count} pages indexed)")
+        Docyard.logger.debug("* Temp directory: #{temp_dir}")
       end
     end
   end

data/lib/docyard/search/pagefind_support.rb CHANGED Viewed

@@ -17,7 +17,7 @@ module Docyard
       end
       def build_pagefind_args(site_dir)
-        args = ["pagefind", "--site", site_dir]
+        args = ["pagefind", "--site", site_dir, "--output-subdir", "_docyard/pagefind"]
         exclusions = config.search.exclude || []
         exclusions.each do |pattern|

data/lib/docyard/server/asset_handler.rb CHANGED Viewed

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
+require "digest"
+require_relative "../utils/path_utils"
 module Docyard
   class AssetHandler
     TEMPLATES_ASSETS_PATH = File.join(__dir__, "../templates", "assets")
+    CACHE_MAX_AGE = 3600
+    DEFAULT_PUBLIC_DIR = "docs/public"
+    attr_reader :public_dir
     CONTENT_TYPES = {
       ".css" => "text/css; charset=utf-8",
@@ -23,47 +30,52 @@ module Docyard
       ".webm" => "video/webm"
     }.freeze
-    def serve_docyard_assets(request_path)
-      asset_path = request_path.delete_prefix("/_docyard/")
+    def initialize(public_dir: DEFAULT_PUBLIC_DIR)
+      @public_dir = public_dir
+    end
-      return forbidden_response if directory_traversal?(asset_path)
+    def serve_docyard_assets(request_path)
+      asset_path = Utils::PathUtils.decode_path(request_path.delete_prefix("/_docyard/"))
       return serve_components_css if asset_path == "css/components.css"
       return serve_components_js if asset_path == "js/components.js"
-      file_path = File.join(TEMPLATES_ASSETS_PATH, asset_path)
+      file_path = safe_asset_path(asset_path, TEMPLATES_ASSETS_PATH)
+      return forbidden_response unless file_path
       return not_found_response unless File.file?(file_path)
       serve_file(file_path)
     end
     def serve_public_file(request_path)
-      asset_path = request_path.delete_prefix("/")
+      asset_path = Utils::PathUtils.decode_path(request_path.delete_prefix("/"))
-      return nil if directory_traversal?(asset_path)
-      file_path = File.join(Constants::PUBLIC_DIR, asset_path)
-      return nil unless File.file?(file_path)
+      file_path = safe_asset_path(asset_path, public_dir)
+      return nil unless file_path && File.file?(file_path)
       serve_file(file_path)
     end
     private
-    def directory_traversal?(path)
-      path.include?("..")
+    def safe_asset_path(relative_path, base_dir)
+      Utils::PathUtils.resolve_safe_path(relative_path, base_dir)
     end
     def serve_file(file_path)
       content = File.read(file_path)
-      content_type = detect_content_type(file_path)
+      headers = build_cache_headers(content, File.mtime(file_path))
+      headers["Content-Type"] = detect_content_type(file_path)
-      [200, { "Content-Type" => content_type }, [content]]
+      [200, headers, [content]]
     end
     def serve_components_css
       content = concatenate_component_css
-      [200, { "Content-Type" => "text/css; charset=utf-8" }, [content]]
+      headers = build_cache_headers(content)
+      headers["Content-Type"] = "text/css; charset=utf-8"
+      [200, headers, [content]]
     end
     def concatenate_component_css
@@ -76,7 +88,10 @@ module Docyard
     def serve_components_js
       content = concatenate_component_js
-      [200, { "Content-Type" => "application/javascript; charset=utf-8" }, [content]]
+      headers = build_cache_headers(content)
+      headers["Content-Type"] = "application/javascript; charset=utf-8"
+      [200, headers, [content]]
     end
     def concatenate_component_js
@@ -92,6 +107,15 @@ module Docyard
       CONTENT_TYPES.fetch(extension, "application/octet-stream")
     end
+    def build_cache_headers(content, last_modified = nil)
+      headers = {
+        "Cache-Control" => "public, max-age=#{CACHE_MAX_AGE}",
+        "ETag" => %("#{Digest::MD5.hexdigest(content)}")
+      }
+      headers["Last-Modified"] = last_modified.httpdate if last_modified
+      headers
+    end
     def forbidden_response
       [403, { "Content-Type" => "text/plain" }, ["403 Forbidden"]]
     end