使用 mkdocs 搭建个人 wiki 站点

原文： https://rebootcat.com/2020/09/20/wiki/

why wiki

博客通常是用来记录一些完整的文章，每篇文章有一个主题。但是我想把平日里的一些笔记也记录到我的博客里，但笔记是零散的，随时的，不是完整的一个主题。所以打算构建一个 wiki 页面，专门用来存放我的笔记，wiki 页面类似于 维基百科的形式。

我的博客采用的是 hexo 构建的，如果打算 DIY 一个类似于 维基百科 的 wiki 页面的话，对于我来说，也许有点难度，毕竟我只会写简单的网页。那么有没有现成的方案或者替代的方案呢？

答案是有的，那就是 mkdocs。

mkdocs 使用

什么是 Mkdocs 呢？

MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introduction below, then check the User Guide for more info.

mkdocs 是一个用 python 编写的静态站点生成工具，主要是用来编写项目文档，文档使用 Markdown 编写，只需要配合一个 YAML 配置文件，就能快速生成一个站点。

毫无疑问，对于我来说，它有以下几个优点：

• 使用 python 编写（说明有 DIY 的可能）
• 源文件使用 Markdown 编写
• 只需要一个 Yaml 文件，非常简单了
• 主题可选（当然目前来说不是特别多）

可以先看一下 我的wiki.

快速开始

可以参考官方文档：mkdocs.org，或者直接往下看：

首先安装 mkdocs:

$ pip install mkdocs

安装完成之后直接生成一个项目：

$ mkdocs new mysite                                                                    [23:33:49]
INFO    -  Creating project directory: