ruby-md-ssg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df65115f64a772c620d615e8b0bb752d340bc47821ffc9228a976369c8a65514
-  data.tar.gz: 1b0e4cfd186cb5b26c0d61051579ab13aec4b0ddf2afe7ec42f5d02d593e364f
+  metadata.gz: c43097acb4ef035583e37a2a668d83bdc6522f0c33eab8917cb276b963c478c5
+  data.tar.gz: f1a7e9d0f5d514a29cd181f6a77efe8be598462c4700790627bc9f21b8d79e50
 SHA512:
-  metadata.gz: 283a2e7203583828fd569f7104b87f8b60a14991562070b315e6b057156fc0fe6015aa10eef6b6d4d371c25b626ef2ab2da943e3153bfff2c63852fc47e34a5e
-  data.tar.gz: f8fdc454c0b484223430bcc130e230fff533f472a8306230d9fe467b4d258ae98b7c86b6c3ecc8b1fd4b4a4ff6e2dcc511259643982fb9a4c30047157ca11b3d
+  metadata.gz: 500ef9b8abc74e5e997850427e330401b54240f4273bd05cf36a3877be69a833d3c43058cd516dfeaa8b09114f295d2e954e753758e8d1855ad6c816271c2d98
+  data.tar.gz: 6347f1845b09279476f723cba1c2137c7a23f3d330879ffde553aedc723af7b9cac2e0a7e72072649e8e5f4903fc158dfc96919b21d1e5c56cf641c26d2914c6

data/README.md

@@ -12,6 +12,6 @@ bundle exec ruby bin/test
 ## CLI
 
 - `ruby_md_ssg new my-site` — scaffold a new project using the bundled template
-- `ruby_md_ssg build` — regenerate the site into `build/` (also emits `sitemap.xml`; pass `--base-url` to control absolute URLs)
+- `ruby_md_ssg build` — regenerate the site into `build/` (also emits `sitemap.xml`; pass `--base-url`/`--base-path` to control canonical URLs and link prefixes)
 - `ruby_md_ssg serve` — serve the site locally with automatic rebuilds
 - `ruby_md_ssg menu` — refresh `docs/menu.yml`

data/lib/ruby_md_ssg/cli.rb

@@ -100,7 +100,8 @@ module RubyMdSsg
         build_dir: options[:build],
         assets_dir: options[:assets],
         menu_path: options[:menu],
-        base_url: options[:base_url]
+        base_url: options[:base_url],
+        base_path: options[:base_path]
       )
       compiler.compile
     end
@@ -136,6 +137,13 @@ module RubyMdSsg
         opts.on('--assets PATH', 'Assets directory') do |path|
           options[:assets] = File.expand_path(path)
         end
+        opts.on(
+          '--base-path PATH',
+          'Base path prefix for links/assets',
+          'defaults to ENV RUBY_MD_SSG_BASE_PATH'
+        ) do |path|
+          options[:base_path] = path
+        end
         opts.on(
           '--base-url URL',
           'Base URL for sitemap entries (defaults to ENV RUBY_MD_SSG_BASE_URL)'
@@ -164,6 +172,7 @@ module RubyMdSsg
       options[:build] ||= RubyMdSsg::Paths.build_dir
       options[:menu] ||= RubyMdSsg::Paths.menu_config
       options[:assets] ||= RubyMdSsg::Paths.assets_dir
+      options[:base_path] ||= ENV.fetch('RUBY_MD_SSG_BASE_PATH', nil)
       options[:base_url] ||= ENV.fetch('RUBY_MD_SSG_BASE_URL', nil)
       options.delete_if { |_key, value| value.nil? }
     end

data/lib/ruby_md_ssg/compiler.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'nokogiri'
+require 'uri'
 require_relative 'paths'
 require_relative 'document_finder'
 require_relative 'menu_config'
@@ -16,13 +17,15 @@ module RubyMdSsg
       build_dir: Paths.build_dir,
       assets_dir: Paths.assets_dir,
       menu_path: Paths.menu_config,
-      base_url: nil
+      base_url: nil,
+      base_path: nil
     )
       @docs_dir = docs_dir
       @build_dir = build_dir
       @assets_dir = assets_dir
       @menu_path = menu_path
       @base_url = base_url
+      @base_path = base_path || derive_base_path_from_base_url(base_url)
       @markdown = MarkdownRenderer.new
       @layout = LayoutRenderer.new
       @html_formatter = HtmlFormatter.new
@@ -46,7 +49,7 @@ module RubyMdSsg
     private
 
     attr_reader :docs_dir, :build_dir, :assets_dir, :menu_path,
-                :markdown, :layout, :html_formatter, :base_url
+                :markdown, :layout, :html_formatter, :base_url, :base_path
 
     def purge_build
       FileUtils.rm_rf(build_dir)
@@ -67,7 +70,12 @@ module RubyMdSsg
 
     def render_document(document, menu)
       html_body = markdown.render(document.body_markdown)
-      page = layout.render(document: document, body_html: html_body, menu: menu)
+      page = layout.render(
+        document: document,
+        body_html: html_body,
+        menu: menu,
+        base_path: normalized_base_path
+      )
       page = html_formatter.format(page)
       output_path = document.output_path
       FileUtils.mkdir_p(File.dirname(output_path))
@@ -106,10 +114,39 @@ module RubyMdSsg
 
     def sitemap_location_for(route)
       normalized_route = route == '/' ? '/' : route
-      return normalized_route if base_url.nil? || base_url.empty?
+      return route_with_base_path(route) if base_url.nil? || base_url.empty?
 
       normalized_base = base_url.end_with?('/') ? base_url.chomp('/') : base_url
       normalized_base + normalized_route
     end
+
+    def route_with_base_path(route)
+      return '/' if normalized_base_path.empty? && (route.nil? || route == '/')
+      return normalized_base_path if !normalized_base_path.empty? && (route.nil? || route == '/')
+
+      tail = route.delete_prefix('/')
+      normalized_base_path.empty? ? "/#{tail}" : "#{normalized_base_path}/#{tail}"
+    end
+
+    def derive_base_path_from_base_url(url)
+      return nil if url.nil? || url.empty?
+
+      uri = URI.parse(url)
+      path = uri.path
+      path == '/' ? nil : path
+    rescue URI::InvalidURIError
+      nil
+    end
+
+    def normalized_base_path
+      @normalized_base_path ||= normalize_base_path(base_path)
+    end
+
+    def normalize_base_path(path)
+      return '' if path.nil? || path.empty? || path == '/'
+
+      normalized = path.start_with?('/') ? path : "/#{path}"
+      normalized.chomp('/')
+    end
   end
 end

data/lib/ruby_md_ssg/layout_renderer.rb

@@ -9,12 +9,13 @@ module RubyMdSsg
       @template_path = template_path
     end
 
-    def render(document:, body_html:, menu:)
+    def render(document:, body_html:, menu:, base_path: '')
       template.result_with_hash(
         title: document.title,
         body_html: body_html,
         menu: menu,
-        meta_description: document.meta_description
+        meta_description: document.meta_description,
+        helpers: TemplateHelpers.new(base_path)
       )
     end
 
@@ -29,5 +30,48 @@ module RubyMdSsg
     def default_template_path
       File.join(Paths.root, 'templates', 'layout.html.erb')
     end
+
+    class TemplateHelpers
+      def initialize(base_path)
+        @base_path = normalize_base_path(base_path)
+      end
+
+      def asset_path(filename)
+        build_path('assets', filename)
+      end
+
+      def route_path(route)
+        return base_path if base_path? && root_route?(route)
+        return '/' if root_route?(route)
+
+        build_path(route.delete_prefix('/'))
+      end
+
+      private
+
+      attr_reader :base_path
+
+      def base_path?
+        !base_path.empty?
+      end
+
+      def normalize_base_path(path)
+        return '' if path.nil? || path.empty? || path == '/'
+
+        normalized = path.start_with?('/') ? path : "/#{path}"
+        normalized.chomp('/')
+      end
+
+      def build_path(*segments)
+        tail = segments.join('/').sub(%r{^/+}, '')
+        return "/#{tail}" unless base_path?
+
+        "#{base_path}/#{tail}"
+      end
+
+      def root_route?(route)
+        route.nil? || route == '/'
+      end
+    end
   end
 end

data/lib/ruby_md_ssg/server.rb

@@ -22,7 +22,8 @@ module RubyMdSsg
           auto_build: true,
           watch: true,
           interval: 1.0,
-          base_url: ENV.fetch('RUBY_MD_SSG_BASE_URL', nil)
+          base_url: ENV.fetch('RUBY_MD_SSG_BASE_URL', nil),
+          base_path: ENV.fetch('RUBY_MD_SSG_BASE_PATH', nil)
         }
       end
     end
@@ -51,7 +52,8 @@ module RubyMdSsg
         build_dir: options[:build],
         assets_dir: options[:assets],
         menu_path: options[:menu],
-        base_url: options[:base_url]
+        base_url: options[:base_url],
+        base_path: options[:base_path]
       )
       compiler.compile
       puts "[#{timestamp}] Build complete."

data/lib/ruby_md_ssg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMdSsg
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/template/site/README.md.erb

@@ -10,6 +10,7 @@ Generated by Ruby MD SSG <%= gem_version %>.
 - `bundle exec ruby_md_ssg test` — run the Minitest suite (if present)
 
 Set `RUBY_MD_SSG_BASE_URL` (or pass `--base-url`) when building to control sitemap URLs.
+Set `RUBY_MD_SSG_BASE_PATH` (or pass `--base-path`) when deploying under a subdirectory (e.g., GitHub Pages project sites).
 
 Docs live in `docs/`, assets in `assets/`, templates in `templates/`.
 

data/template/site/templates/layout.html.erb

@@ -7,8 +7,8 @@
     <% if meta_description && !meta_description.empty? %>
       <meta name="description" content="<%= meta_description %>" />
     <% end %>
-    <link rel="stylesheet" href="/assets/style.css" />
-    <script defer src="/assets/app.js"></script>
+    <link rel="stylesheet" href="<%= helpers.asset_path('style.css') %>" />
+    <script defer src="<%= helpers.asset_path('app.js') %>"></script>
   </head>
   <body>
     <div class="layout">
@@ -24,7 +24,7 @@
               <ul>
                 <% section.links.each do |link| %>
                   <li>
-                    <a href="<%= link.route %>"><%= link.label %></a>
+                    <a href="<%= helpers.route_path(link.route) %>"><%= link.label %></a>
                   </li>
                 <% end %>
               </ul>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-md-ssg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ruby MD SSG Maintainers