Camus

English | 中文

Camus is a static site generator written in C++23. It converts Markdown posts into static HTML pages with theme support, file watching, catalog generation, and sitemap generation — all bundled into a single self-contained binary.

• Self-contained: The example site template is embedded in the binary. Use -i to bootstrap a new site instantly.
• Fast: Built with C++23, optimized for performance with release builds.
• Watch mode: Auto-rebuilds when source files change.
• Multi-theme: Choose from default, accent, pixel, and terminal themes, or write your own.
• Catalog: Generate a structured table of contents for multi-level directory hierarchies.
• Sitemap: Automatic sitemap.xml generation.

camus -iw mysite    	# Install the example template into ./mysite
camus -Ww mysite       	# Watch and auto-rebuild on changes
camus -I              	# Inspect and display the current configuration

The built site is output to html/ by default.

After running camus -i, your working directory will contain:

.
├── .env                  # Environment variables ({{env.KEY}} in templates)
├── .gitignore
├── camus.yaml            # Site configuration
├── .camus/               # Internal template cache
├── assets/               # Static assets (copied to output as-is)
├── posts/                # Markdown posts
└── theme/                # HTML templates

• see example

Template variables are replaced during rendering. Use {{env.key}} in your HTML templates:

Each Markdown file starts with YAML front matter:

---
short-path: my-post
display-name: My First Post
date: 2025-03-21
visibility: open
tags: [ "example", "text" ]
---

Wrap content with markers to exclude it from rendering:

--hidden-section-start
This content will not appear in the output.
--hidden-section-end

• CMake 3.28.3+
• GCC or Clang with C++23 support
• Git (to clone submodules)

git clone --recurse-submodules https://github.com/o8x/camus.git camus
make -C camus build

The template is automatically embedded into the binary as a post-build step.

make build       # Release build
make serve       # Build and serve on localhost:8000
make push        # Build and push to GitHub Pages
make package     # Build a release package

All dependencies are included as Git submodules:

This project is distributed under the terms found in the LICENSE file.