Welcome to Rotkeeper

A Bash-native, Oliver-driven static site and content system for Markdown, documentation, and local-first themes.

Welcome to Rotkeeper

Rotkeeper: A Ritual CLI for Flat-File Decay

Rotkeeper turns Markdown with YAML frontmatter into a static site with Oliver. The system is Bash-native, locally vendored, and organized around three places: bones/ for the machinery, home/ for authored content, and output/ for rendered artifacts.

Each file is a tomb. Each version is a ritual. Each render is final.

🧪 Run the Pipeline

From the repository root:

bash rotkeeper.sh init --full
bash rotkeeper.sh render
bash rotkeeper.sh assets

Use render for HTML, assets to copy local CSS/fonts/images/JavaScript into output/assets/, and status to inspect the current environment.

🗺️ Index

🧾 Docs

Learn the layout, configuration, ritual scripts, and documentation workflow.

🆘 Help

Start with the practical command and workflow notes.

🧰 Rotkeeper Reference

Read the project reference and current operating notes.

🎭 Showcase

Compare the available themes, including the persistent Spooky dark and light variants.

📝 First Page

See the smallest authored content example in the current tree.

🦴 Current Rituals

  • bash rotkeeper.sh dip audits and stitches documentation.
  • bash rotkeeper.sh book --fsbook builds the filesystem catalog DIP consumes.
  • bash rotkeeper.sh glue repairs missing content indexes.
  • bash rotkeeper.sh links audits every local link and asset reference in rendered HTML.
  • bash rotkeeper.sh showcase generates theme showcase pages.
  • bash rotkeeper.sh autopsy --all refreshes script help/output reports for DIP.
  • bash rotkeeper.sh scan checks files against the asset manifest.
  • bash rotkeeper.sh test runs the integration and release assertions.

The source documentation lives under home/content/docs. Generated HTML belongs under output/; do not edit it directly.

🎨 Themes

The default is theme-spooky-dark.html, using locally vendored Fira Sans and Fira Code. theme-spooky-light.html, theme-dark.html, theme-light.html, theme-kawaii.html, theme-overgrown.html, and theme-phosphor.html remain available for explicit page frontmatter.

New to the project? Start with the Docs. Want to compare layouts? Visit the Showcase.