Anydocs Documents
进阶

从源码构建

面向贡献者和本地调试者的 Anydocs 源码运行路径。

从源码构建是给贡献者和本地调试 Anydocs 本身的人用的。普通文档作者如果只是交付 docs project,优先用已发布的 CLI、Studio 和 MCP 就够了。

Steps

  1. 准备环境并进入仓库
  2. 安装依赖
  3. 启动 Studio 开发环境
  4. 单独预览 reader
  5. 在改代码时执行构建和测试

准备环境并进入仓库

确保本机满足 Node.js >= 18 和 pnpm >= 9,然后克隆或打开 Anydocs 仓库根目录。

安装依赖

在仓库根目录执行 `pnpm install`,安装 monorepo 所需依赖。

启动 Studio 开发环境

用 `pnpm dev` 启动本地 Studio 开发环境;如果你在调试桌面壳,可以改用 `pnpm dev:desktop`。

单独预览 reader

reader 预览不要依赖 `pnpm dev`。要查看已发布 reader 运行时,请另开终端,用 CLI 对某个 docs project 启动 preview,例如 `examples/demo-docs`。

在改代码时执行构建和测试

需要验证源码改动时,再运行 `pnpm build`、`pnpm test`,必要时加上更具体的工作区测试命令。

`pnpm dev` 不提供完整 reader 路由: plain `pnpm dev` 主要是 Studio 开发入口。要验证公开阅读站行为,应使用 CLI `preview` 指向具体 docs project。
示例命令: 常见组合是:`pnpm dev` 启 Studio,再用 `pnpm --filter @anydocs/cli cli preview examples/demo-docs` 预览示例 reader。