-
采用
Markdown
语法编辑文章 -
支持
Latex
公式(MathJex) -
按分类/年份归档文章
-
自动部署到
Github Page
-
修改mkdocs.yml和about.md定义博客信息
-
修改extra.css自定义样式(可选,覆盖
mkdocs
主题默认样式) -
在docs文件夹下创建文章
-
为便于自动按年份归档,文件名格式
yyyy-mm-dd-title.md
-
为便于自动分类文章,提供元信息
categories
-
文章基本结构(元信息、标题为可选项)
--- categories: [foo, bar, ...] tags: [this, that, ...] --- # title --- markdown-content ...
-
-
提交更新到远程
master
分支,触发Github Action
自动构建和部署
安装Python及以下第三方库
$ pip install mkdocs
$ pip install pymdown-extensions
执行make
命令:
-
调试模式(等效为创建归档/分类页面后执行
mkdocs serve
)$ make serve
通过浏览器访问
127.0.0.1:8000
-
构建静态页面(等效为创建归档/分类页面后执行
mkdocs build
)$ make build