Lettuce Docs Tags Graph

lettuce docs

#docs#cli#reference
~1 min read

lettuce docs

Build a static site from the in-app documentation vault.

lettuce docs <subcommand>

Subcommands

Subcommand What it does
publish [--out PATH] [--base-url URL] Materialise the bundled docs and render them to a static site

lettuce docs publish

lettuce docs publish --out site/docs/

Materialises the bundled docs vault to a temporary directory and builds a static site from it. The output is a complete static site of the documentation, ready to push.

Flag Default What it does
--out PATH ./docs-site Where to write the static site
--base-url URL — Absolute base URL for links and canonical tags

With no flags, the site is written to ./docs-site:

lettuce docs publish

This is what the release flow calls to keep https://lettuce.drbaher.com/docs/ in sync with the in-app docs.