Getting started

Install #

dokk needs Python 3.11 or newer.

pip install "dokk[serve,search]"

uv pip install "dokk[serve,search]"

The serve extra adds the dev server, search adds the Pagefind index. Both are optional, as is format, for dokk format.

Scaffold a site in a new folder:
```
dokk init --root my-docs
```
Start the dev server and open http://127.0.0.1:8002/:
```
dokk serve --root my-docs
```
Edit my-docs/docs/index.md. The browser reloads when you save.
Build the production site into my-docs/.dokk/build/:
```
dokk build --root my-docs
```

dokk init creates dokk.toml, docs/index.md, a .gitignore and a GitHub Pages workflow.

Tip

Run dokk check before you publish. It finds broken links, missing anchors and missing images.