Skip to content
v0.6.5

Quick start

First, install Canofold in your project.

  1. Initialize

    Run this command from the project root:

    bash
    pnpm exec canofold init --locale en

    It creates canofold.config.ts, docs/index.md, and a type declaration without overwriting existing content.

  2. Add scripts
    package.json
    {  "scripts": {    "docs:dev": "canofold dev",    "docs:check": "canofold check",    "docs:build": "canofold build",    "docs:preview": "canofold preview"  }}
  3. Start the development server
    bash
    pnpm docs:dev

    Open the printed URL and edit docs/index.md.

Build the site

bash
pnpm docs:checkpnpm docs:buildpnpm docs:preview

Static files are written to .canofold/dist/. Continue with content structure, theming, or deployment.