版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/qq_21570029/article/details/84934590
首先使用 pip 安装 mkdocs :
$ pip install mkdocs在terminal 输入以下命令行:
mkdocs new my-project
cd my-project到目录位置
看到以上目录
MkDocs 包含了一个内建的服务器以预览当前文档. 控制台切换当前目录到 mkdocs.yml 配置文件相同文件夹
在terminal 输入以下命令行
mkdocs serve在浏览器中打开 http://127.0.0.1:8000/ , 你将看到以下页面:
此时可以开始你的文档编写之旅了
扫描二维码关注公众号，回复：
4443002 查看本文章
文件属性
mkdocs.yml
如图所示：
添加页面
现在为文档添加第二个页面:
$ curl 'jaspervdj.be/lorem-markdownum/markdown.txt' > docs/error_solve.md
即docs下为你编写的项目文档的markdown文件
刷新浏览器即可看到 错误解决 和 股票数据获取API 导航栏目.
内部超链接
即mkdocs使用的是markdown格式编写文档，所以使用如下方法即可链接到你编写的文档
[.*]（此处为你在docs下生成的文档，docs为根目录,即url为/api/data_upgrate）
我们现在已经可以发布文档了. 通过以下命令生成文档.
$ mkdocs build