MkDocs生成静态站点

安装

安装Material for MkDocs需要Python和Python包管理器pip：

pip install mkdocs-material
pip install minify-plugin
pip install redirects

创建项目

创建一个my-docs文件夹，输入以下命令开始一个新的项目。

cd my-docs
mkdocs new .

在my-docs目录中，可以看到

.
├─ docs/
│  └─ index.md
└─ mkdocs.yml

其中，mkdocs.yml是站点的配置文件，docs文件夹就是markdown文件 存放的位置.

快速开始

直接替换mkdoc.yml即可，下方点击下载，按需修改。

• mkdocs.yml
• mathjax.js

上述配置文件中，用到的本地文件均在docs目录下，目录结构如下：

.
├─ docs/
│  ├─ assets
|  |  └─ images
|  |     └─ favicon.png
|  ├─ javascripts
|  |  └─ mathjax.js 
|  ├─ python
|  |  └─ 修改下载源.md
|  ├─ 建站过程
|  |  ├─ MkDocs生成静态站点.md
|  |  └─ 建站思路.md
|  ├─ 杂记
|  |  ├─ markdown语法.md
|  |  └─ 科学上网方法.md
│  └─ index.md
└─ mkdocs.yml

本地预览

mkdocs serve --dev-addr=127.0.0.1:8002

输入上述命令后，可以在 http://127.0.0.1:8002 中预览内容。

文档编译

mkdocs build

上述目录下的文件是文档的源码，通过mkdocs build 命令可以编译生成site目录，这个目录下包含了所有的html文档信息。

├─assets
│  ├─images
│  ├─javascripts
│  │  ├─lunr
│  │  │  └─min
│  │  └─workers
│  └─stylesheets
├─search
├─404.html
├─index.html
├─sitemap.xml
└─sitemap.xml.gz

---

本文总阅读量 次