文档站点使用 Sphinx 与 sphinx-book-theme 构建,正文采用 MyST Markdown;不再使用 Docusaurus、Node.js 或 npm 构建链。
在仓库根目录执行以下命令:
# 首次运行时创建虚拟环境
python3 -m venv .venv
source .venv/bin/activate
# 安装文档依赖
python -m pip install -r docs/requirements.txt
# 构建 HTML 文档
make -C docs html
# 启动本地静态服务器
python -m http.server 8000 --directory docs/_build/html浏览器打开 http://localhost:8000 即可预览文档。
构建结果位于 docs/_build/html/,也可以直接运行:
sphinx-build -b html docs docs/_build/htmlMermaid 图表在 HTML 中由浏览器端渲染,不要求本机安装 mermaid-cli。