Getting Started

guide

Install

With uv (recommended):

uv tool install rockgarden

Or with pip:

pip install rockgarden

Build a Site

Point rockgarden at any directory of Markdown files:

rockgarden build

By default, rockgarden reads Markdown from the current directory and writes HTML to ./_site/. No configuration required. Obsidian syntax (wiki-links, embeds, callouts) is supported automatically.

Preview the result:

rockgarden serve

Adding Configuration

Create rockgarden.toml to customize behavior:

[site]
title = "My Site"
source = "content"    # read from ./content/ instead of ./
output = "_site"      # write to ./_site/ instead of ./site/

[build]
ignore_patterns = [".obsidian", "Templates"]

See Configuration for all available options.

Initialize a Project

To generate a starter rockgarden.toml:

rockgarden init

Next Steps

Customization: custom CSS, templates, themes, and more
Configuration: full configuration reference
Markdown Support: supported syntax reference