Skip to content

mkdocs 安装

创建虚拟环境

安装相应包

pip install mkdocs
pip install mkdocs-material

修改配置文件

使用主题 metrial,和语法高亮插件 codehilite。

site_name: Memo

theme:
  name: 'material'

markdown_extensions:
  - codehilite

常用命令

预览

mkdocs serve

生成站点

mkdocs build

部署

仓库主要有两条分支:

  • master:用于编写 markdown、配置文件等
  • gh-pages:用于展示网站内容

编写新的文档在 master 分支,gh-pages 分支不能编辑否则有可能会出现冲突。 gh-pages 是命令 mkdocs gh-deploy 使用的。

配置仓库的 settings 中设置展示的 GitHub Pages 为 gh-pages branc。

custom domain 为:memo.g10guang.com,在 master 分支的 mkdocs.yml 配置文件中的 docs_dir 目录下(默认为 docs),创建一个 CNAME 文件,内容如下:

memo.g10guang.com

部署命令:

mkdocs gh-deploy