最近，我开发了个API站，写文档站太累了，于是在谷歌搜索怎么样快速生成的时候看到了Mkdocs
先简单的介绍一下Mkdocs
MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.
好了，废话不多说，我们开始
1.安装Python
1.下载
首先，去下载Python（过程太简单，就不说了
2.安装
这个安装基本上是傻瓜式安装，一直点Next就好了
3.设置环境变量
我们设置PATH这样在cmd直接输入pip也能运行，否则会报找不到途径或命令
右击我的电脑–>属性–>高级系统设置–>高级–>环境变量–>新建，按照下图设置
2.安装Mkdocs
1.pip安装
直接pip安装即可
[text]pip install mkdocs[/text]
如果出现下图错误，更新一下pip就好了
[text] python -m pip install –upgrade pip [/text]
重新pip安装即可
[text]pip install mkdocs[/text]
3.建立文档
这个就很简单了
1.建立项目
[text] mkdocs new my-project cd my-project [/text]
2.启动网站
输入以下命令即可启动网站服务
[text]mkdocs serve[/text]
启动后即可在127.0.0.1:8000看到你的文档站
3.生成站点
[text]mkdocs build[/text]
在D:\Doc\test\site即可看到你文档的静态html页面
4.最后
由于这个其实也压在草稿箱很久了，所有有些地方我可能因为太久忘了没讲到，所以有错误或讲的不清的欢迎在评论中指出
广告
暂不开放评论，如对本文有任何疑问或建议，请联系apple@mr-wu.top
All Tags