完整官方文档： mkdocs.org.

安装

# 1. 安装 python
# 2. 安装 pip
# pip换源，此处为腾讯源
pip config set global.index-url https://mirrors.cloud.tencent.com/pypi/simple

# 安装mkdocs
pip install mkdocs

# 安装主题
pip install mkdocs-material

# 插件
pip install mkdocs-minify-plugin

命令

  • mkdocs new [dir-name] - 创建一个项目
  • mkdocs serve - 启动服务
  • mkdocs build - 构建静态文件
  • mkdocs -h - 打印帮助文件

项目文件布局

新建项目后，会自动创建mkdocs.yml和 docs 目录，

mkdocs.yml    # 配置文件
docs/
    index.md  # 文档主页
    ...       # 其它文档文件

常用主题

1. GitBook Theme

安装：

pip install mkdocs-gitbook

使用，修改配置文件mkdocs.yml

theme: gitbook

2. material

配置指南：官网

pip install mkdocs-material
theme:
  name: material

如何定制导航栏

在 mkdocs.yml 文件中写入以下配置

nav:
  - "index.md"
  - 标题名:
      - 标题名: "开发笔记/测试.md"
  - "about/about.md"

使用 mkdocs 的项目

mkdocs插件库

MkDocs-Plugins：https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins