codex-bot
422d6622a2
Verify and deploy Tabularium / verify-and-deploy (pull_request) Has been cancelled
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# 开始使用
|
|
|
|
Tabularium 是 Endor 的文档工作台。文档与图形源码都保存在同一个仓库。
|
|
|
|
## 启动
|
|
|
|
在仓库根目录运行：
|
|
|
|
```sh
|
|
pnpm install --frozen-lockfile
|
|
uv sync --project tools/figures --locked
|
|
pnpm dev
|
|
```
|
|
|
|
浏览器打开 http://127.0.0.1:3000 。
|
|
|
|
## 添加文档
|
|
|
|
在 `content/docs` 下添加 Markdown 文件，例如 `04-runtime.md`。文件名使用小写字母、数字和连字符；第一个一级标题是导航标题。在 `content/catalog.json` 的 `documents` 中以源文件路径登记 `slug` 和 `category`，例如 `slug: "endor/runtime"`、`category: "Endor"`。公开地址为 `/docs/endor/runtime`；源文件编号仅用于排序，不进入公开 URL。既有源文件地址保留永久跳转，修改已有公开 slug 时需另行保留旧地址映射。
|
|
|
|
开发模式下刷新页面读取修改；本地生产预览需要重新构建。
|
|
|
|
## 检查
|
|
|
|
```sh
|
|
pnpm check
|
|
pnpm start
|
|
```
|
|
|
|
本地开发入口只监听 127.0.0.1。main 推送会在 ces-control 上验证并自动部署，服务器入口默认 18135。相同构建输入复用已验证镜像；源码变化时复用依赖与 Next.js 缓存。Pull Request 只验证，不部署。
|