编写文档

文档存储在后端存储库的 docs/ 目录中。文档使用 MkDocs 构建。文档使用 Markdown 编写。有关更多信息，请查看 MkDocs 文档。

在本地构建文档站点

1. 安装文档依赖项

   重要提示

   我们建议创建一个 python 虚拟环境 来安装文档要求。

   make docs/install
   

2. 运行文档服务。

   make docs/serve
   

3. 导航到 http://localhost:8000 以查看文档站点。

添加新页面

1. 在 docs/ 下创建一个新的 markdown 文件
2. 在项目根目录下的 mkdocs.yml 中的 "nav" 部分下添加您的新文件。