MkDocs项目文档生成器(一)

简介

类别：项目文档生成器，生成静态站点，管理MarkDown文档。

官方网址：http://www.mkdocs.org/

中文文档：http://markdown-docs-zh.readthedocs.io/zh_CN/latest/ 建议直接看最新的英文官方文档

特点：

• 一个用于创建项目文档的快速、简单、华丽的静态站点生成器，文档源码使用 Markdown 来撰写,，用一个 YAML 文件作为配置文档。
• 构建完全的静态 HTML 站点，可以将它托管到 GitHub pages、Amazon S3 等任意地方。
• 默认包含大量美观的主题，可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。
• 即时预览
• 易于配置
• 交叉索引

安装

​ 由于小编当前的公司使用的是Windows开发环境，所以在此处给出MkDocs在Window 10的安装和使用教程，有Macbook的请直接去看官方文档，用Linux的请绕道别处。

1.需要安装Python：面向对象的解释型语言，因为MkDocs是基于Python工作的，所以需要有Python环境的支持，Mkdocs支持2.6/2.7/3.3/3.4/3.5(去官网看最新的支持)；

2.需要安装Pip：Python的包管理器，如果安装了高版本的Python，会附带安装；

3.安装MkDocs：即本文主要讲的项目文档生成器；

4.另外，由于MkDocs的官方文档建议使用Chocolatey来安装Python和Pip，所以在此处我们也学习一下这个Windows的包管理器(软件管理器)；

我的配置

• chocolatey 0.10.0
• Python 3.5.1
• pip 8.1.2
• mkdocs 0.15.3
• PC Win 10 专业版 64-bit 8G Dell

Chocolatey

简介 - Windows的包管理器

如果使用过Linux的话，一定会被其简洁的软件包管理系统所折服。在Linux世界中，安装一个软件不需要在浏览器中寻找软件的官网，然后将其下载下来，然后双击进行安装。只需要一条简单的命令，就可以完成搜索、安装、更新、卸载等所有操作。例如Debian和Ubuntu中的apt-get命令，Fedora的yum以及新的dnf命令，还有Arch中的pacman。其实Windows下,也有这么一个包管理器，功能虽然不及Linux中那些包管理器强大，但是也让Windows下的软件安装方便了不少。这就是Chocolatey。

远离插件，远离广告，远离病毒，真正的一行命令安装一个软件，感觉棒棒哒！！！

官方网址

https://chocolatey.org/

安装

官方教程地址：https://chocolatey.org/install

1. C:\Windows\System32，找到cmd.exe，右键选择使用管理员权限打开
2. 将下面的代码粘贴到命令行中，然后回车，等待安装即可。

@powershell -NoProfile -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"