Initialize local Tabularium documentation monorepo
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
# 开始使用
|
||||
|
||||
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`。文件名使用小写字母、数字和连字符;第一个一级标题是导航标题。该文件对应 `/docs/04-runtime`。
|
||||
|
||||
开发模式下刷新页面读取修改;本地生产预览需要重新构建。
|
||||
|
||||
## 检查
|
||||
|
||||
```sh
|
||||
pnpm check
|
||||
pnpm start
|
||||
```
|
||||
|
||||
所有命令都在本地运行。Git 远程只负责源码同步,不承担构建或部署。
|
||||
Reference in New Issue
Block a user