Skip to content

rotkeeper.yaml Documentation

Browse Docs pages

rotkeeper.yaml

Documentation for bones/config/rotkeeper.yaml. This file was auto-generated by the Document Improvement Project (DIP).

Overview

YAML configuration for site metadata, templates, navigation, source formats, and optional layout/path mappings.

Details

Configuration file intended to be manually edited or read by Rotkeeper scripts.

Notes

Design

The YAML file supplies project metadata, default templates, input format, and the theme registry. theme_registry.default takes precedence over default_template. Page frontmatter can select a different template. The navigation block provides site-relative link targets and labels.

Limits

Without layout_style, paths use the crypt layout. Without a paths block, environment loading derives paths from the repository root. Unsupported input formats or render profiles fall back to Markdown or HTML.

Cautions

Strict bootstrap validates YAML and any saved path cache. A saved root must match the checkout, and cached paths must agree with the selected layout. Use bash rotkeeper.sh init to regenerate mappings after relocation or a layout change. Registered template files must exist in the active template directory.

Reads and writes

This file is not a script; no script environment contract applies.

Usage

This file has no command-line interface.

History

[0.3.0.14] - 2026-06-15