๐Ÿ“ Template Library

๐Ÿงฑ Template Library

Rotkeeper supports basic HTML template rendering using Pandoc-compatible layouts. This page catalogs the included templates, explains layout logic, and outlines how to create or override your own.


๐Ÿ“ Where Templates Live

Templates are stored in the /templates/ directory.

You can define which ones get copied during init using init-config.yaml:

templates:
  - templates/stackburger.html
  - templates/rot-notice.html

๐Ÿ” stackburger.html

The default layout for HTML output. It includes: - A head with linked stylesheets - A placeholder for page content - Optional asset/meta inclusion logic

You can customize it to include: - OpenMoji icons - Static banners - Post-render scripts - Log-referenced inline metadata


๐Ÿšซ rot-notice.html

A minimal template for rendering warnings, blank states, or expired tomb notices. Use this if you need to output content thatโ€™s been redacted or obsoleted.


๐Ÿ›  How to Make a New Template

  1. Create an HTML file in /templates/
  2. Use Pandocโ€™s templating syntax ($body$, $title$, etc.)
  3. Optionally add an asset-meta block:
<!--
asset-meta:
  file: templates/my-custom.html
  version: 0.1.0
  tomb-version: 0.1.7.5
  tracked: true
  author: "tomb-engine"
-->
  1. Reference the new template in your init-config.yaml or pass it via CLI:
pandoc input.md -o output.html --template templates/my-custom.html

๐Ÿงฌ Custom Layout Conventions


Back to Asset Pipeline Continue to Content Structure

Author:

Project: Rotkeeper

Version: 0.2.3-pre

License: