Skip to content

Repository overview

The README entry point and the basic Rotkeeper workflow.

Browse Docs pages

README.md is the repository entry point. It introduces Rotkeeper, the system/content/output layout, requirements, setup, and the command list.

Rotkeeper uses Bash and Oliver to turn flat-file content into static HTML. It does not require Node or an application framework. In the default layout, source content is under home/content, assets under home/assets, and generated pages under output.

Starting a site

bash rotkeeper.sh preflight
bash rotkeeper.sh init --with-sample
bash rotkeeper.sh render
bash rotkeeper.sh status

Use the workflow guide for the full sequence and the Oliver contract for renderer setup. Read the agent operating manual reference before changing the project.