5ceb4e57aae962e34fdbf3d8e43e0c6773358f4b
Endor · Tabularium
Endor 文档与制图 monorepo。Tabularium 取古罗马档案馆之意。
本地开发
需要 Node.js 22.13+(推荐 LTS)、pnpm 11.25、Python 3.11+ 和 uv。 首次安装依赖需要访问软件包源;站点、制图和检查均在本机运行。
pnpm install --frozen-lockfile
uv sync --project tools/figures --locked
pnpm dev
访问 http://127.0.0.1:3000 。站点无外部字体或 CDN 资源。
apps/docs/ Next.js Pages Router + React + TypeScript + Tailwind CSS
content/docs/ Markdown 文档源,文件名成为 /docs/<slug> 路由
tools/figures/ 独立 Python 项目,使用 drawsvg 编程制图
命令
pnpm dev:本地开发,修改 Markdown 后刷新页面即可读取新内容。pnpm figures:运行 Python 制图,更新apps/docs/public/figures。pnpm lint/pnpm typecheck:前端静态检查。pnpm build:构建文档站。pnpm start:在本地预览已构建站点。pnpm check:依次执行 lint、类型检查、制图与构建。
文档标题取首个 # 标题,文档排序按文件名。普通 Markdown 与 GFM 表格可用,嵌入图使用 /figures/<name>.svg。不解析原始 HTML。
生产构建会生成文档路由;新增或修改文档后重新运行 build。开发模式按请求读取内容。 所有工作流只在本地执行,不配置 CI 或部署。远程 Git 仅用于保存和同步源码。
Git 远程
请创建空仓库 endorphin-tabularium-docs,不要初始化 README 或许可证。
得到实际仓库地址后再添加 origin 并推送。不要假定仓库所有者或使用其他用户凭据。
Description
Languages
TypeScript
63.2%
Python
24.7%
CSS
9.5%
JavaScript
2.1%
Shell
0.4%
Other
0.1%