Minimalist documentation site generator

build.rb

require "kramdown"
require "mustache"
require "fileutils"

WEB_DIR = "./public"
DOCUMENT_TPL = ".site/templates/document.html"
INDEX_TPL = ".site/templates/index.html"
HOME_TPL = ".site/templates/homepage.html"

Mustache.template_path = ".site/templates/partials"
Mustache.template_extension = "html"

INDEXES = {}

def build_document(source_path)
  doc_title, target_doc = parse_document(source_path)
  target_path = "#{WEB_DIR}/#{source_path.gsub('.md', '.html')}"
  target_dir = File.dirname(target_path)
  FileUtils.mkdir_p(target_dir) unless File.directory?(target_dir)
  File.write(target_path, render_document(doc_title, target_doc))
  append_index(target_path, doc_title)
end

def append_index(path, title)
  dir_key = File.dirname(path)
  INDEXES[dir_key] = [] unless INDEXES.key?(dir_key)
  INDEXES[dir_key] << { title: title, url: path.gsub("#{WEB_DIR}/.", "") }
end

def write_indexes
  INDEXES.each do |index_dir,listing|
    index_path = "#{index_dir}/index.html"
    index_title = index_dir.gsub("#{WEB_DIR}/./", "").capitalize
    File.write(index_path, render_index(index_title, listing))
  end

  homepage_path = "#{WEB_DIR}/index.html"
  File.write(homepage_path, Mustache.render(File.read(HOME_TPL)))
end

def parse_document(source_path)
  source = File.read(source_path)
  title = extract_title(source.lines.first)
  content = Kramdown::Document.new(source, input: "GFM", syntax_highlighter: "rouge").to_html
  [title, content]
end

def extract_title(first_line)
  return "Untitled Document" if first_line.nil? || first_line[0] != '#'
  first_line.split("# ").last
end

def render_document(title, content)
  Mustache.render(File.read(DOCUMENT_TPL), {title: title, content: content})
end

def render_index(title, listing)
  Mustache.render(File.read(INDEX_TPL), {title: title, listing: listing})
end

entries = Dir["./*/**.md"].sort

entries.each do |path|
  build_document(path)
end

write_indexes

FileUtils.cp_r(".site/assets", "public")