Quick start
First, install Canofold in your project.
- Initialize
Run this command from the project root:
pnpm exec canofold init --locale enIt creates
canofold.config.ts,docs/index.md, and a type declaration without overwriting existing content. - Add scripts
{ "scripts": { "docs:dev": "canofold dev", "docs:check": "canofold check", "docs:build": "canofold build", "docs:preview": "canofold preview" }} - Start the development server
pnpm docs:devOpen the printed URL and edit
docs/index.md.
Build the site
pnpm docs:checkpnpm docs:buildpnpm docs:previewStatic files are written to .canofold/dist/. Continue with content structure, theming, or deployment.

