docyard 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea61eefa97dc9199d17929def1315fdf2ce71f75ddf4f03833b9291fa64ce75
-  data.tar.gz: '0538fae77efffb84a8aac4ba979510419ff2a8cd8eec1b5aaf9effc2950595d8'
+  metadata.gz: 69c121af95a08c379f260d0d444aa4bc5272fdfe2d0699866091885c9f503601
+  data.tar.gz: 4550cdcc1d6863b545c4900aac9adb10f14d96a7394ccd3fe4c8924969b278dc
 SHA512:
-  metadata.gz: f184c67f1be8766cdd6339da6b25ccd8b7f1d0150ce3f6c0db0de8dd68c590b82e29f76a4ec1928c29151018d318225f2769cea58be9ad1dc2c721a2593663d5
-  data.tar.gz: 982f4bdcd4170dd013dd5ee10fb21db935eeafcb486372a45db7ae58a3f8d75e6c716555585695ea9527cc7fbd2bf0e43c5a7982894160ec6832c591c2db45a1
+  metadata.gz: 690e11d0792b71540f09d26fe45dc46d57558b3aad1b3cf80f3e08c592a4056408b6b8a57bfc47f2459feba94e481038f11ccef287534a9f82e557c255728b53
+  data.tar.gz: 8baa1a707f2ff94152499b66c19596a57984c5ff763d2cf43390d986030e2e2eea994febac3089766a764ec1d6314a61479fe2caa54434ee5e64c86ade6431e1

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.2] - 2026-01-23
+
+### Fixed
+- "Last updated" timestamps now show correct dates when deploying via CI (#129)
+
+### Documentation
+- Added git history requirements for accurate timestamps on GitHub Actions, Vercel, and Netlify
+
 ## [1.0.1] - 2026-01-22
 
 ### Added
@@ -216,7 +224,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial gem structure
 - Project scaffolding
 
-[Unreleased]: https://github.com/sanifhimani/docyard/compare/v1.0.1...HEAD
+[Unreleased]: https://github.com/sanifhimani/docyard/compare/v1.0.2...HEAD
+[1.0.2]: https://github.com/sanifhimani/docyard/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/sanifhimani/docyard/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/sanifhimani/docyard/compare/v0.9.0...v1.0.0
 [0.9.0]: https://github.com/sanifhimani/docyard/compare/v0.8.0...v0.9.0

data/lib/docyard/build/asset_bundler.rb

@@ -142,7 +142,8 @@ module Docyard
       def replace_content_image_paths(content, base_url)
         return content if base_url == "/"
 
-        content.gsub(%r{(<img[^>]*\ssrc=")/(?!_docyard/)([^"]*")}) do
+        base_path_pattern = Regexp.escape(base_url.delete_prefix("/"))
+        content.gsub(%r{(<img[^>]*\ssrc=")/(?!_docyard/|#{base_path_pattern})([^"]*")}) do
           "#{Regexp.last_match(1)}#{base_url}#{Regexp.last_match(2)}"
         end
       end

data/lib/docyard/build/static_generator.rb

@@ -155,7 +155,8 @@ module Docyard
         @navigation_builder ||= Navigation::PageNavigationBuilder.new(
           docs_path: docs_path,
           config: config,
-          sidebar_cache: sidebar_cache
+          sidebar_cache: sidebar_cache,
+          base_url: config.build.base
         )
       end
 

data/lib/docyard/navigation/page_navigation_builder.rb

@@ -7,10 +7,11 @@ require_relative "breadcrumb_builder"
 module Docyard
   module Navigation
     class PageNavigationBuilder
-      def initialize(docs_path:, config:, sidebar_cache: nil)
+      def initialize(docs_path:, config:, sidebar_cache: nil, base_url: "/")
         @docs_path = docs_path
         @config = config
         @sidebar_cache = sidebar_cache
+        @base_url = base_url
       end
 
       def build(current_path:, markdown:, header_ctas: [], show_sidebar: true)
@@ -26,7 +27,7 @@ module Docyard
 
       private
 
-      attr_reader :docs_path, :config, :sidebar_cache
+      attr_reader :docs_path, :config, :sidebar_cache, :base_url
 
       def empty_navigation
         { sidebar_html: "", prev_next_html: "", breadcrumbs: nil }
@@ -47,7 +48,8 @@ module Docyard
           sidebar_tree: sidebar_builder.tree,
           current_path: current_path,
           frontmatter: markdown.frontmatter,
-          config: {}
+          config: {},
+          base_url: base_url
         ).to_html
       end
 

data/lib/docyard/navigation/prev_next_builder.rb

@@ -5,13 +5,14 @@ require_relative "../utils/path_resolver"
 
 module Docyard
   class PrevNextBuilder
-    attr_reader :sidebar_tree, :current_path, :frontmatter, :config
+    attr_reader :sidebar_tree, :current_path, :frontmatter, :config, :base_url
 
-    def initialize(sidebar_tree:, current_path:, frontmatter: {}, config: {})
+    def initialize(sidebar_tree:, current_path:, frontmatter: {}, config: {}, base_url: "/")
       @sidebar_tree = sidebar_tree
       @current_path = Utils::PathResolver.normalize(current_path)
       @frontmatter = frontmatter
       @config = config
+      @base_url = base_url
     end
 
     def prev_next_links
@@ -27,7 +28,7 @@ module Docyard
       links = prev_next_links
       return "" if links.nil? || (links[:prev].nil? && links[:next].nil?)
 
-      Renderer.new.render_partial(
+      Renderer.new(base_url: base_url).render_partial(
         "_prev_next", {
           prev: links[:prev],
           next: links[:next],

data/lib/docyard/rendering/renderer.rb

@@ -35,7 +35,7 @@ module Docyard
       markdown = Markdown.new(raw_content, config: config, file_path: file_path)
 
       render(
-        content: strip_md_from_links(markdown.html),
+        content: process_content_links(markdown.html),
         page_title: markdown.title || Constants::DEFAULT_SITE_TITLE,
         page_description: markdown.description,
         page_og_image: markdown.og_image,
@@ -51,7 +51,7 @@ module Docyard
     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)
+      content = process_content_links(markdown.html)
 
       <<~HTML
         <!DOCTYPE html>
@@ -170,10 +170,25 @@ module Docyard
       @footer_links = footer[:links]
     end
 
+    def process_content_links(html)
+      rewrite_internal_links(strip_md_from_links(html))
+    end
+
     def strip_md_from_links(html)
       html.gsub(/href="([^"]+)\.md"/, 'href="\1"')
     end
 
+    def rewrite_internal_links(html)
+      return html if base_url == "/"
+
+      html.gsub(%r{href="(/(?!/)[^"]*)"}) do |_match|
+        path = ::Regexp.last_match(1)
+        next %(href="#{path}") if path.start_with?(base_url)
+
+        %(href="#{base_url.chomp('/')}#{path}")
+      end
+    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

data/lib/docyard/server/preview_server.rb

@@ -11,12 +11,13 @@ module Docyard
   class PreviewServer
     DEFAULT_PORT = 4000
 
-    attr_reader :port, :output_dir
+    attr_reader :port, :output_dir, :base_url
 
     def initialize(port: DEFAULT_PORT)
       @port = port
       @config = Config.load
       @output_dir = File.expand_path(@config.build.output)
+      @base_url = normalize_base_url(@config.build.base)
       @launcher = nil
     end
 
@@ -38,12 +39,12 @@ module Docyard
     def print_server_info
       Docyard.logger.info("Starting preview server...")
       Docyard.logger.info("* Version: #{Docyard::VERSION}")
-      Docyard.logger.info("* Running at: http://localhost:#{port}")
+      Docyard.logger.info("* Running at: http://localhost:#{port}#{base_url}")
       Docyard.logger.info("Use Ctrl+C to stop\n")
     end
 
     def run_server
-      app = StaticFileApp.new(output_dir)
+      app = StaticFileApp.new(output_dir, base_path: base_url)
       puma_config = build_puma_config(app)
       log_writer = Puma::LogWriter.strings
 
@@ -64,5 +65,12 @@ module Docyard
         config.quiet
       end
     end
+
+    def normalize_base_url(url)
+      return "/" if url.nil? || url.empty?
+
+      url = "/#{url}" unless url.start_with?("/")
+      url.end_with?("/") ? url : "#{url}/"
+    end
   end
 end

data/lib/docyard/server/static_file_app.rb

@@ -4,15 +4,20 @@ require "rack/mime"
 
 module Docyard
   class StaticFileApp
-    def initialize(root)
+    def initialize(root, base_path: "/")
       @root = root
+      @base_path = base_path.chomp("/")
     end
 
     def call(env)
       path = env["PATH_INFO"]
-      file_path = File.join(@root, path)
 
-      if path.end_with?("/") || File.directory?(file_path)
+      return serve_not_found unless path_under_base?(path)
+
+      relative_path = strip_base_path(path)
+      file_path = File.join(@root, relative_path)
+
+      if relative_path.end_with?("/") || relative_path.empty? || File.directory?(file_path)
         index_path = File.join(file_path, "index.html")
         return serve_file(index_path) if File.file?(index_path)
       elsif File.file?(file_path)
@@ -24,6 +29,18 @@ module Docyard
 
     private
 
+    def path_under_base?(path)
+      return true if @base_path.empty?
+
+      path == @base_path || path.start_with?("#{@base_path}/")
+    end
+
+    def strip_base_path(path)
+      return path if @base_path.empty?
+
+      path.delete_prefix(@base_path)
+    end
+
     def serve_file(path)
       content = File.read(path)
       content_type = Rack::Mime.mime_type(File.extname(path), "application/octet-stream")

data/lib/docyard/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sanif Himani
@@ -178,7 +178,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: Beautiful, zero-config documentation sites. Built with Ruby.
+description: Generate beautiful documentation sites from Markdown
 email:
 - sanifhimani92@gmail.com
 executables:
@@ -403,13 +403,16 @@ files:
 - lib/docyard/utils/text_formatter.rb
 - lib/docyard/utils/url_helpers.rb
 - lib/docyard/version.rb
-homepage: https://github.com/sanifhimani/docyard
+homepage: https://docyard.dev
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/sanifhimani/docyard
+  homepage_uri: https://docyard.dev
   source_code_uri: https://github.com/sanifhimani/docyard
+  changelog_uri: https://github.com/sanifhimani/docyard/blob/main/CHANGELOG.md
+  documentation_uri: https://docyard.dev
+  bug_tracker_uri: https://github.com/sanifhimani/docyard/issues
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -429,5 +432,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Documentation generator for Ruby
+summary: Generate beautiful documentation sites from Markdown
 test_files: []