ruby-md-ssg 0.1.0

data/lib/ruby_md_ssg/menu_generator.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'yaml'
+require_relative 'paths'
+require_relative 'document_finder'
+require_relative 'menu_config'
+
+module RubyMdSsg
+  class MenuGenerator
+    def initialize(docs_dir: Paths.docs_dir, menu_path: Paths.menu_config)
+      @docs_dir = docs_dir
+      @menu_path = menu_path
+    end
+
+    def generate
+      documents = DocumentFinder.new(docs_dir: docs_dir).all
+      default_menu = MenuConfig.from_documents(documents)
+      config = if File.exist?(menu_path)
+                 merge_existing(MenuConfig.load(menu_path), default_menu)
+               else
+                 default_menu
+               end
+
+      serialized = YAML.dump(config.to_h)
+      FileUtils.mkdir_p(File.dirname(menu_path))
+      existing = File.exist?(menu_path) ? File.read(menu_path) : nil
+      File.write(menu_path, serialized) unless existing == serialized
+      menu_path
+    end
+
+    private
+
+    attr_reader :docs_dir, :menu_path
+
+    def merge_existing(existing, default_menu)
+      default_lookup = {}
+      default_menu.sections.each do |section|
+        default_lookup[normalized(section.title)] = section
+      end
+
+      merged_sections = existing.sections.map do |existing_section|
+        key = normalized(existing_section.title)
+        default_section = default_lookup.delete(key)
+        if default_section
+          SectionMerger.merge(existing_section, default_section)
+        else
+          existing_section
+        end
+      end
+
+      additional_sections = default_lookup.values.sort_by(&:title)
+      MenuConfig.new(merged_sections + additional_sections)
+    end
+
+    def normalized(value)
+      value.to_s.downcase
+    end
+
+    module SectionMerger
+      module_function
+
+      def merge(existing_section, default_section)
+        existing_links = {}
+        existing_section.links.each do |link|
+          existing_links[normalized(link.route)] = link
+        end
+        default_section.links.each do |link|
+          key = normalized(link.route)
+          existing_links[key] ||= link
+        end
+
+        merged_links = existing_section.links.map { |link| existing_links[normalized(link.route)] }
+        additional_links = existing_links.values.reject { |link| merged_links.include?(link) }
+        merged_links += additional_links
+        RubyMdSsg::MenuConfig::Section.new(
+          title: existing_section.title,
+          links: merged_links
+        )
+      end
+
+      def normalized(value)
+        value.to_s.downcase
+      end
+    end
+  end
+end

data/lib/ruby_md_ssg/paths.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RubyMdSsg
+  module Paths
+    module_function
+
+    def root
+      @root ||= begin
+        env_root = ENV.fetch('RUBY_MD_SSG_ROOT', nil)
+        if env_root && !env_root.empty?
+          File.expand_path(env_root)
+        else
+          Dir.pwd
+        end
+      end
+    end
+
+    def root=(value)
+      @root = value && File.expand_path(value)
+    end
+
+    def reset!
+      @root = nil
+    end
+
+    def docs_dir
+      File.join(root, 'docs')
+    end
+
+    def build_dir
+      File.join(root, 'build')
+    end
+
+    def assets_dir
+      File.join(root, 'assets')
+    end
+
+    def menu_config
+      File.join(docs_dir, 'menu.yml')
+    end
+
+    def templates_dir
+      File.join(root, 'templates')
+    end
+  end
+end

data/lib/ruby_md_ssg/server.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'webrick'
+require 'digest'
+
+module RubyMdSsg
+  class Server
+    class << self
+      def start(options = {})
+        new(default_options.merge(options)).start
+      end
+
+      private
+
+      def default_options
+        {
+          port: 4000,
+          docs: Paths.docs_dir,
+          build: Paths.build_dir,
+          assets: Paths.assets_dir,
+          menu: Paths.menu_config,
+          auto_build: true,
+          watch: true,
+          interval: 1.0,
+          base_url: ENV.fetch('RUBY_MD_SSG_BASE_URL', nil)
+        }
+      end
+    end
+
+    def initialize(options)
+      @options = options
+      @server = nil
+    end
+
+    def start
+      build_site if options[:auto_build]
+      watch_for_changes if options[:watch]
+      start_server
+    end
+
+    private
+
+    attr_reader :options, :server
+
+    def build_site
+      generator = MenuGenerator.new(docs_dir: options[:docs], menu_path: options[:menu])
+      generator.generate
+
+      compiler = Compiler.new(
+        docs_dir: options[:docs],
+        build_dir: options[:build],
+        assets_dir: options[:assets],
+        menu_path: options[:menu],
+        base_url: options[:base_url]
+      )
+      compiler.compile
+      puts "[#{timestamp}] Build complete."
+    rescue StandardError => e
+      warn "[build] #{e.class}: #{e.message}"
+      e.backtrace&.take(5)&.each { |line| warn "  #{line}" }
+    end
+
+    def watch_for_changes
+      Thread.new do
+        last = fingerprint
+        loop do
+          sleep options[:interval]
+          current = fingerprint
+          next if current == last
+
+          puts '[watch] Change detected. Rebuilding...'
+          build_site
+          last = current
+        rescue StandardError => e
+          warn "[watch] #{e.class}: #{e.message}"
+        end
+      end
+    end
+
+    def start_server
+      @server = WEBrick::HTTPServer.new(
+        Port: options[:port],
+        DocumentRoot: options[:build],
+        AccessLog: [],
+        Logger: WEBrick::Log.new($stderr, WEBrick::Log::INFO)
+      )
+
+      trap('INT') { server.shutdown }
+
+      puts "Serving #{options[:build]} at http://localhost:#{options[:port]}"
+      server.start
+    end
+
+    def fingerprint
+      files = watched_files
+      return 'empty' if files.empty?
+
+      Digest::SHA1.hexdigest(
+        files.sort.flat_map do |path|
+          [path, File.mtime(path).to_f.to_s, (File.size?(path) || 0).to_s]
+        end.join('|')
+      )
+    end
+
+    def watched_files
+      patterns = [
+        File.join(options[:docs], '**', '*.md'),
+        File.join(options[:docs], '*.yml'),
+        File.join(options[:assets], '**', '*'),
+        File.join(Paths.root, 'templates', '**', '*.erb')
+      ]
+      patterns.flat_map { |pattern| Dir.glob(pattern, File::FNM_DOTMATCH) }
+              .select { |path| File.file?(path) }
+    end
+
+    def timestamp
+      Time.now.strftime('%H:%M:%S')
+    end
+  end
+end

data/lib/ruby_md_ssg/version.rb

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

data/lib/ruby_md_ssg.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'ruby_md_ssg/version'
+require_relative 'ruby_md_ssg/paths'
+require_relative 'ruby_md_ssg/document'
+require_relative 'ruby_md_ssg/document_finder'
+require_relative 'ruby_md_ssg/menu_config'
+require_relative 'ruby_md_ssg/menu_generator'
+require_relative 'ruby_md_ssg/markdown_renderer'
+require_relative 'ruby_md_ssg/layout_renderer'
+require_relative 'ruby_md_ssg/html_formatter'
+require_relative 'ruby_md_ssg/compiler'
+require_relative 'ruby_md_ssg/server'
+require_relative 'ruby_md_ssg/cli'

data/template/site/Gemfile.erb

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'ruby-md-ssg', '~> <%= gem_version %>'
+
+group :development do
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', require: false
+end
+
+group :test do
+  gem 'minitest', '~> 5.22'
+end

data/template/site/README.md.erb

@@ -0,0 +1,16 @@
+# <%= project_name %>
+
+Generated by Ruby MD SSG <%= gem_version %>.
+
+## Commands
+
+- `bundle exec ruby_md_ssg build` — regenerate the site into `build/` (writes `sitemap.xml`)
+- `bundle exec ruby_md_ssg serve` — serve `build/` with automatic rebuilds
+- `bundle exec ruby_md_ssg menu` — refresh `docs/menu.yml`
+- `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.
+
+Docs live in `docs/`, assets in `assets/`, templates in `templates/`.
+
+GitHub Pages deployment is configured via `.github/workflows/deploy.yml`; adjust the workflow or remove it if you handle deployments differently.

data/template/site/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/testtask'
+
+desc 'Run test suite'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc 'Run RuboCop'
+task :lint do
+  sh 'bundle exec rubocop'
+end
+
+desc 'Build the static site'
+task :build do
+  sh 'bundle exec ruby_md_ssg build'
+end
+
+desc 'Serve the static site'
+task :serve do
+  sh 'bundle exec ruby_md_ssg serve'
+end
+
+task default: :test

data/template/site/assets/app.js

@@ -0,0 +1,12 @@
+// Base script for Ruby MD SSG
+document.addEventListener('DOMContentLoaded', () => {
+  const currentPath = window.location.pathname.replace(/\/$/, '') || '/';
+  document
+    .querySelectorAll('.layout__menu a')
+    .forEach((link) => {
+      const linkPath = link.getAttribute('href').replace(/\/$/, '') || '/';
+      if (linkPath === currentPath) {
+        link.classList.add('is-active');
+      }
+    });
+});

data/template/site/assets/style.css

@@ -0,0 +1,106 @@
+/* Base layout for Ruby MD SSG */
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
+  background: #f8f9fb;
+  color: #111;
+}
+
+a {
+  color: #0366d6;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+.layout {
+  display: grid;
+  grid-template-columns: 320px 1fr;
+  min-height: 100vh;
+}
+
+.layout__sidebar {
+  background: #111827;
+  color: #f8f9fb;
+  padding: 2rem;
+  position: sticky;
+  top: 0;
+  align-self: start;
+  height: 100vh;
+  overflow-y: auto;
+}
+
+.layout__header h1 {
+  margin: 0;
+  font-size: 1.5rem;
+}
+
+.layout__header p {
+  margin: 0.5rem 0 1.5rem;
+  color: rgba(248, 249, 251, 0.7);
+}
+
+.layout__menu {
+  display: grid;
+  gap: 1.5rem;
+}
+
+.menu-section h2 {
+  margin: 0;
+  font-size: 0.875rem;
+  text-transform: uppercase;
+  letter-spacing: 0.08em;
+  color: rgba(248, 249, 251, 0.6);
+}
+
+.menu-section ul {
+  list-style: none;
+  padding: 0;
+  margin: 0.75rem 0 0;
+  display: grid;
+  gap: 0.4rem;
+}
+
+.menu-section a {
+  color: #f8f9fb;
+  display: block;
+  padding: 0.25rem 0;
+}
+
+.menu-section a.is-active {
+  font-weight: 600;
+  color: #38bdf8;
+}
+
+.layout__content {
+  padding: 3rem;
+  background: white;
+}
+
+.layout__content article {
+  max-width: 720px;
+}
+
+.layout__content h1 {
+  font-size: 2.25rem;
+  margin-top: 0;
+}
+
+.layout__content p {
+  line-height: 1.6;
+  font-size: 1rem;
+}
+
+.layout__content pre {
+  background: #1f2937;
+  color: #f8f9fb;
+  padding: 1rem;
+  border-radius: 6px;
+  overflow: auto;
+}

data/template/site/bin/build

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ruby_md_ssg'
+
+RubyMdSsg::CLI.start(['build', *ARGV])

data/template/site/bin/compile

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ruby_md_ssg'
+
+RubyMdSsg::CLI.start(['build', *ARGV])

data/template/site/bin/generate_menu

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ruby_md_ssg'
+
+RubyMdSsg::CLI.start(['menu', *ARGV])

data/template/site/bin/serve

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ruby_md_ssg'
+
+RubyMdSsg::CLI.start(['serve', *ARGV])

data/template/site/bin/test

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+env = {}
+env['TEST'] = ENV['TEST'] if ENV['TEST']
+env['TESTOPTS'] = ENV['TESTOPTS'] if ENV['TESTOPTS']
+
+exec(env, 'bundle', 'exec', 'rake', 'test')

data/template/site/docs/blog/launch.md

@@ -0,0 +1,11 @@
+# Ruby MD SSG Launch Notes
+
+Welcome to the first release of Ruby MD SSG. The goal is to build static sites with a tiny toolchain.
+
+## Highlights
+
+- Full-site rebuild in a single command.
+- Navigation driven by human-editable YAML.
+- Zero JavaScript build tooling required.
+
+Tell us what features you need next by opening an issue.

data/template/site/docs/guides/setup.md

@@ -0,0 +1,7 @@
+# Getting Started
+
+1. Install Ruby 3.2 or newer.
+2. Run `bundle install` inside the repository.
+3. Execute `bundle exec ruby_md_ssg build` to generate the static site. This also emits `build/sitemap.xml`; set `RUBY_MD_SSG_BASE_URL` or pass `--base-url` to control URLs.
+
+You can now open the files in the `build/` directory or run the server command to preview locally.

data/template/site/docs/guides/workflow.md

@@ -0,0 +1,7 @@
+# Recommended Workflow
+
+- Write new content in `docs/` using markdown headings to outline the story.
+- Regenerate the menu with `bundle exec ruby_md_ssg menu` so the navigation picks up new pages.
+- Rebuild the site with `bundle exec ruby_md_ssg build` and review the output (including `build/sitemap.xml`) before opening a pull request.
+
+Keep each page focused on a single topic and prefer relative links when referencing peer documents.

data/template/site/docs/ideas/government.md

@@ -0,0 +1,5 @@
+# Civic Technology Ideas
+
+- Publish budget highlights in plain language.
+- Host open office hours for every department. 
+- Track public project milestones transparently.

data/template/site/docs/index.md.erb

@@ -0,0 +1,8 @@
+---
+title: <%= helpers.human_project_name %>
+description: Site generated with Ruby MD SSG <%= gem_version %>.
+---
+
+# Welcome to <%= helpers.human_project_name %>
+
+Ruby MD SSG converts markdown content into a static site with a shared layout. Update this file to change the landing page.

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

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title><%= title %> · Ruby MD SSG</title>
+    <% 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>
+  </head>
+  <body>
+    <div class="layout">
+      <aside class="layout__sidebar">
+        <header class="layout__header">
+          <h1>Ruby MD SSG</h1>
+          <p>Markdown to static site with minimal tooling.</p>
+        </header>
+        <nav class="layout__menu">
+          <% menu.sections.each do |section| %>
+            <section class="menu-section">
+              <h2><%= section.title %></h2>
+              <ul>
+                <% section.links.each do |link| %>
+                  <li>
+                    <a href="<%= link.route %>"><%= link.label %></a>
+                  </li>
+                <% end %>
+              </ul>
+            </section>
+          <% end %>
+        </nav>
+      </aside>
+      <main class="layout__content">
+        <article>
+          <%= body_html %>
+        </article>
+      </main>
+    </div>
+  </body>
+</html>