顾宇的博客
·
通过 Github Actions 部署 Mkdocs 文档
💡
原文中文，约1600字，阅读约需4分钟。
📝
内容提要
本文介绍了如何通过Github Actions自动部署Mkdocs文档。Mkdocs是一个轻量级的静态HTML文档框架，支持Python。首先安装Mkdocs及其主题，创建文档站点并进行测试，生成HTML并部署到Github Pages。最后，通过Github Actions实现自动化部署，简化发布流程。
🎯
关键要点
- Mkdocs 是一个轻量级的静态 HTML 文档框架，支持 Python。
- 通过 pip 安装 Mkdocs 及其主题，例如 mkdocs-material。
- 使用命令 'mkdocs new <目录>' 创建文档站点，生成 mkdocs.yml 文件和 docs 目录。
- 执行 'mkserve' 可以在本地查看初始化的文档，Mkdocs 会监测目录改动并更新浏览器。
- 执行 'mkdocs build' 生成 HTML 文件，并使用 'mkdocs gh-deploy' 将内容提交到 gh-pages 分支。
- 通过 Github Actions 自动化构建和发布，只需创建 .github/workflow/gh-deploy.yml 文件。
- 提交后，站点会自动部署到 Github Pages，未来的提交也会触发该流程。
❓
延伸问答
Mkdocs是什么？
Mkdocs是一个轻量级的静态HTML文档框架，支持Python。
如何安装Mkdocs及其主题？
可以通过命令 'pip install --user mkdocs mkdocs-material' 安装Mkdocs及其主题。
如何创建和测试Mkdocs文档站点？
使用命令 'mkdocs new <目录>' 创建文档站点，然后执行 'mkserve' 在本地查看文档。
如何生成HTML并部署到Github Pages？
执行 'mkdocs build' 生成HTML文件，然后使用 'mkdocs gh-deploy' 提交到gh-pages分支。
Github Actions如何自动化Mkdocs的部署？
通过创建 .github/workflow/gh-deploy.yml 文件，配置自动化构建和发布流程。
未来的提交如何影响Mkdocs的自动部署？
未来的提交会触发Github Actions自动部署流程，自动更新站点。
➡️
