okami-chen / docs

MeterSphere 项目在线文档

本仓库保存了 MeterSphere 项目 的 官方文档，该文档使用 MkDocs 文档框架下的 Material for MkDocs 主题进行构建。

本地开发

克隆本仓库

git clone https://github.com/metersphere/docs.git

安装依赖

cd docs
pip install -r requirements/requirements.txt

修改文档内容

本文档的文档结构定义在 mkdocs.yml 文件中，文档的具体内容均在 docs 目录中。

文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 mkdocs.yml 文件中的 nav 部分增加对应章节导航。

本地调试文档

mkdocs serve

执行上述命令后，可通过 http://127.0.0.1:8000 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

构建文档

mkdocs build

执行上述命令后，会在 site 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

问题反馈

如果您发现文档中存在错误，或对文档内容存在疑问，请提交 GitHub Issue 到 MeterSphere 项目的主仓库