跳到正文

快速开始

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

  1. 初始化

    在项目根目录运行:

    bash
    pnpm exec docfuse init

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

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

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

构建站点

bash
pnpm docs:checkpnpm docs:buildpnpm docs:preview

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