标签：zh help Python serve rest 文档 mkdocs

1. 简介

MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.

官网文档：https://markdown-docs-zh.readthedocs.io/zh_CN/latest/

官方网站：https://www.mkdocs.org/

2. 需求

可以用于生成django-rest-framework离线文档，快速查看， 不依赖网速， 也可内网使用

3. 安装

pip install mkdocs

4. 查看帮助

$ mkdocs help
mkdocs [help|new|build|serve|gh-deploy] {options}

5. 创建项目

$ mkdocs new my-project
$ cd my-project

6. 运行项目

$ mkdocs serve
Running at: http://127.0.0.1:8000/

7. 打包项目

mkdocs build --clean

备注：

　　因为django-rest-framework已经有docs目录， 直接打包即可

标签：zh,help,Python,serve,rest,文档,mkdocs
来源： https://www.cnblogs.com/fireblackman/p/15532275.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。