使用 mkdocs 自动生成页面，文档中心。

本文的原文连接是:
http://blog.csdn.net/freewebsys/article/details/71261179

1，关于mkdocs

---

MkDocs 可以同时编译多个markdown文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。

MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。

项目地址是 ：
http://www.mkdocs.org/

2，直接使用docker搭建

---

首先要跑起来的时候，必须要有一个mkdocs.yml 文件。
这个文件是mkdocs的跑起来必须要的文件。
内容：

site_name: mkdocs demo

并且在当前目录创建 一个 docs 文件夹才行。
这个是默认的mk文件存放的地方。

结构如下：

3，启动镜像

---

启动镜像：

docker run --rm -itd --name mkdocs -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

启动之后就是web启动界面了：

和官网网站的一样。
菜单都在顶部。要实现子菜单，多级的。
只要修改 mkdocs.yml 就可以了：

site_name: mkdocs

pages:
- 'Introduction': 'demo.md'
- User Guide:
    - 'user-guide.md'
    - 'user-guide1.md'
- 'About': 'about.md'

pages是多级菜单列表：
需要展示几个显示几个。

中文啥的也当然支持了。

还可以自动生产文件。

docker exec -it mkdocs bash
mkdocs build --clean

直接就生成了静态html了，可以直接放到nginx上面了。

使用样式：
https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes

加上这个命令就行了：

theme: material

很google 风格的样式。http://www.material-ui.com/#/

4，总结

---

使用docker 做开发还是超级的方便的。
我在 mac 上就没有安装成功这个 mkdocs。可能这个是 linux 的有些包没有安装成功。
docker还是非常方便的。除了镜像稍微有点大，其他的没有问题了。
编辑文档还是超级方便的。

本文的原文连接是:
http://blog.csdn.net/freewebsys/article/details/71261179