软件项目文档神器MKDocs

程序员大部分人爱写代码，但是不爱写文档。下面推荐一款软件项目文档神器MKDocs。你又可以愉快地，使用Markdown写文档了。

安装流程

安装python

安装pip

使用pip安装mkdocs

安装python

python的安装比较简单，Mac系统直接就内置了。如果是其他系统，可以直接在python官方下载安装包，按照提示一步步完成即可。

python官网：https://www.python.org/downloads/

安装完python后，我们可以启用终端查看系统python的版本

安装pip

可以在终端使用wget下载 pip的安装文件

wget https://bootstrap.pypa.io/get-pip.py

然后执行：

python get-pip.py

pip安装成功后，可以查看pip的版本

pip --version

安装mkdocs

使用pip安装 mkdocs

pip install mkdocs

安装成功后，可以查看mkdocs的版本

创建文档项目

创建laramall商城系统的文档项目 laramall-doc

mkdocs new laramall-doc

切换到laramall-doc

cd laramall-doc

启动文档项目

mkdocs serve

访问项目网址

http://127.0.0.1:8000

项目截图如下：

官网和主题网址

mkdocs官网

material主题网址

https://squidfunk.github.io/mkdocs-material/

mkdocs的优势

基于markdown写作，非常快捷方便

能生成纯静态html文件

主题精美，主题开发也简单

快速上线 部署简单

基于python

使用yaml文件配置 简单方便

喜欢的朋友，感觉去使用一下吧：）