lume-visual-dashboard

Documentation

This site is built with Zensical from the Markdown files in docs/. The page order and titles are set by nav in zensical.toml. Add new pages there.

To preview it locally with live reload at http://localhost:8000:

uv sync --group docs
uv run zensical serve

CI builds the site with zensical build --strict, so a broken link to another page fails the build. Run the same command before pushing:

uv run zensical build --clean --strict

Link to other pages with relative paths to their .md files, such as [Secrets](/lume-visual-dashboard/deployment/secrets.html). Files outside docs/ aren’t part of the site, so refer to them as code (src/api/live.ts) or link to them on GitHub.

The site is published to GitHub Pages on every push to main; see CI and image builds.

What goes where