Build¶
To build your documentation site, run zensical build.
Usage¶
This will generate the static site in the configured site_dir, with the default being site.
Options¶
You can run zensical build --help to get command-line help for the build command. It supports the following options:
| Option | Short | Description |
|---|---|---|
--config-file | -f | Path to the config file to use. |
--clean | -c | Clean cache. |
--strict | -s | Enable strict mode. |
--help | Show a help message and exit. |
Troubleshooting¶
If a build produces unexpected output, particularly after upgrading Zensical, run a clean build:
This clears the build cache before rebuilding the site. Zensical's architecture is still evolving, and we're fixing the behaviors that can leave stale build state, so clean builds should no longer be necessary in the near term.
If the problem recurs after a clean build, please create an issue.