快速开始
开始前,请先在项目中安装 Docfuse。
- 初始化
在项目根目录运行:
pnpm exec docfuse init命令会创建
docfuse.config.ts、docs/index.md和类型声明,不会覆盖已有内容。 - 添加脚本
{ "scripts": { "docs:dev": "docfuse dev", "docs:check": "docfuse check", "docs:build": "docfuse build", "docs:preview": "docfuse preview" }} - 启动开发服务
pnpm docs:dev打开终端显示的地址,然后编辑
docs/index.md。
构建站点
pnpm docs:checkpnpm docs:buildpnpm docs:preview