f38303b7e0
Add comprehensive documentation for recently implemented features: - [nav] config section (nested, toc toggles) - Complete frontmatter fields reference (10 fields) - Hierarchical navigation behavior with ASCII diagram - Template context: nested_nav, anchors array, page.toc - Nav item structure including children for nested menus
sukr
Minimal static site compiler — suckless, Rust, zero JS.
sukr transforms Markdown content into high-performance static HTML. No bloated runtimes, no unnecessary JavaScript, just clean output.
Features
- Build-time rendering — Syntax highlighting via Tree-sitter, no client JS
- Tera templates — Runtime customizable, no recompilation needed
- Convention over configuration — Add sections by creating directories
- Monorepo support — Multiple sites via
-cflag
Quick Start
# Build
cargo build --release
# Run (uses ./site.toml)
sukr
# Custom config (monorepo)
sukr -c sites/blog/site.toml
# Help
sukr --help
Configuration
Create site.toml:
title = "My Site"
author = "Your Name"
base_url = "https://example.com"
[paths] # All optional
content = "content" # default
output = "public" # default
static = "static" # default
templates = "templates" # default
Content Structure
content/
├── _index.md # Homepage
├── about.md # Standalone page → /about.html
└── blog/
├── _index.md # Section index → /blog/index.html
└── my-post.md # Post → /blog/my-post.html
License
MIT