Zensical¶

Zensical is a static site generator for documentation.

It makes it possible to write the documentation in Markdown and generate beautiful and responsive websites.

(One thing that sometimes makes zensical tricky for me to use, is that some features expect a certain way of formatting markdown files and the code formatter that I am using (Prettier) reformats the content in a way that breaks those features. I use <!-- prettier-ignore-start --> and <!-- prettier-ignore-end --> to disable formatting locally.)

The zensical related settings are defined in the zensical.toml file.

Build the documentation locally by running:

zensical build --clean --strict

Or (preferably) use just:

just build-documentation

Serve the documentation locally by running:

zensical serve