⚡ Quickstart Guide

This guide walks you through creating your first tomb with Rotkeeper.

By the end of this guide, you will have: - Initialized a rotkeeper-compatible project environment - Rendered a Markdown file into HTML using a template - Packed the project into a reproducible .tar.gz tomb

🛠️ Prerequisites

Before you begin: - Make sure bash, tar, and pandoc are installed and available in your shell - Clone or download the Rotkeeper repo: bash git clone https://github.com/your-org/rotkeeper.git cd rotkeeper

1. Initialize the Project

Run the main rotkeeper script with init:

./rotkeeper init

This will: - Create folders (content/, output/, templates/, logs/, etc.) - Seed default configuration files (e.g. init-config.yaml) - Log the steps taken in manifest.txt

You can view the log output in:

cat logs/yougood.brah

2. Add Sample Content

Create a Markdown file inside the content/ directory:

echo "# My First Tomb" > content/example.md

3. Render the Site

Use the render command to convert your Markdown into HTML:

./rotkeeper render

The output will appear in the output/ folder, using the default layout (templates/stackburger.html).

4. Pack the Tomb

Now create a tomb archive of the entire rendered site:

./rotkeeper pack

This will: - Read from manifest.txt - Exclude unwanted files (like archive/) - Output a .tar.gz file in the root project folder

✅ Success

You’ve now built your first tomb. It is reproducible, minimal, and tracked.

From here, explore: