Configuration

sukr is configured via site.toml. All settings have sensible defaults.

Basic Configuration

title    = "My Site"
author   = "Your Name"
base_url = "https://example.com"

Path Configuration

All paths are optional. Default values shown:

[paths]
content   = "content"    # Markdown source files
output    = "public"     # Generated HTML output
static    = "static"     # Static assets (copied as-is)
templates = "templates"  # Tera template files

Paths are resolved relative to the config file location. This enables monorepo setups:

# Build site from subdirectory
sukr -c sites/blog/site.toml
# Paths resolve relative to sites/blog/

CLI Options

sukr                           # Use ./site.toml
sukr -c path/to/site.toml      # Custom config
sukr --config path/to/site.toml
sukr -h, --help                # Show help

Frontmatter

Each Markdown file can have YAML frontmatter:

---
title: Page Title
description: Optional description
date: 2024-01-15 # For blog posts
weight: 10 # Sort order (lower = first)
nav_label: Short Name # Override nav display
section_type: blog # Override section template
template: custom # Override page template
---

Section Types

The section_type field determines which template is used for section indexes:

• blog → templates/section/blog.html
• projects → templates/section/projects.html
• (any other) → templates/section/default.html

If not specified, sukr uses the directory name as the section type.