Installation¶

Zensical requires Python ≥ 3.10.

Install¶

pip install zensical

Create a New Project¶

zensical new my-docs
cd my-docs

This scaffolds the minimal project structure:

my-docs/
├─ docs/
│  └─ index.md
└─ zensical.toml

Local Preview¶

zensical serve

Opens a live-reloading dev server at http://localhost:8000. The page auto-refreshes on any file change.

Build for Production¶

zensical build

Outputs a static site to the site/ directory (or whatever site_dir is set to in your config). Deploy the contents of that directory to any static host — GitHub Pages, Netlify, Cloudflare Pages, S3, etc.

Upgrading¶

pip install --upgrade zensical