Configuration & CLI Options

Kabra is configured entirely through command-line arguments.

Available Options

Option

Description

--src=<path>

Required. Path to the directory containing your source Markdown files.

--out=<path>

Optional. Path to the directory where the generated HTML files should be placed. Defaults to public/.

--assets=<path>

Optional. Path to static assets (images, etc.) referenced by your Markdown. These will be copied to [out]/assets/.

--css=<path>

Optional. Path to a custom style.css. If omitted, Kabra will use its built-in default CSS theme.

--title="<text>"

Optional. Set the <title> tag for the generated website. Defaults to Docs.

help

Display the help message and exit.

Example Command

Generate a documentation site from a docs/ folder, outputting to a public/ folder, while including static images from assets/:

bash
kabra --src=docs/ --out=public/ --assets=assets/