跳到正文
v0.6.5

快速开始

开始前,请先在项目中安装 Canofold。

  1. 初始化

    在项目根目录运行:

    bash
    pnpm exec canofold init

    命令会创建 canofold.config.ts、docs/index.md 和类型声明,不会覆盖已有内容。

  2. 添加脚本
    package.json
    {  "scripts": {    "docs:dev": "canofold dev",    "docs:check": "canofold check",    "docs:build": "canofold build",    "docs:preview": "canofold preview"  }}
  3. 启动开发服务
    bash
    pnpm docs:dev

    打开终端显示的地址,然后编辑 docs/index.md。

构建站点

bash
pnpm docs:checkpnpm docs:buildpnpm docs:preview

静态文件生成到 .canofold/dist/。接下来可以组织内容、定制主题或部署站点。