ekleinod/mkdocs-material

ekleinod/mkdocs-material Docker镜像

快速参考

• 维护者：https://gitlab.com/etg-docker/mkdocs-material/
• Docker Hub地址：https://hub.docker.com/r/ekleinod/mkdocs-material
• 帮助获取：https://gitlab.com/etg-docker/mkdocs-material/%E3%80%81https://gitlab.com/etg-docker/mkdocs-material/-/issues

支持的标签

• 1.4.0, 1.4.0-9.5.22, latest
• 1.3.0, 1.3.0-9.5.10
• 1.2.0, 1.2.0-8.2.16
• 1.1.0, 1.1.0-8.1.3
• 1.0.2, 1.0.2-8.1.2
• 1.0.1, 1.0.1-8.1.2

镜像介绍

这是针对https://squidfunk.github.io/mkdocs-material/%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E5%9F%BA%E4%BA%8E%E5%AE%98%E6%96%B9%E9%95%9C%E5%83%8F%E6%89%A9%E5%B1%95%EF%BC%8C%E6%B7%BB%E5%8A%A0%E4%BA%86%E9%A1%B9%E7%9B%AE%E6%89%80%E9%9C%80%E7%9A%84%E6%8F%92%E4%BB%B6%EF%BC%9A

• weasyprint（用于PDF生成的渲染引擎）
• mkdocs-pdf-export-plugin（PDF导出插件）
• mkdocs-static-i18n（静态国际化插件）

完整变更日志见https://gitlab.com/etg-docker/mkdocs-material/-/blob/main/changelog.md%E3%80%82

使用方法

基础命令

bash
docker run --rm --interactive --tty --name <容器名> --user "$(id -u):$(id -g)" --volume "${PWD}:/docs" ekleinod/mkdocs-material <命令>

说明：/docs为镜像工作目录，挂载本地目录到该路径可直接处理文档。

版本测试

bash
docker run --rm --name mkdocs-material ekleinod/mkdocs-material --version

示例运行

克隆仓库或下载测试文件夹后执行：

bash
cd test
./test_help.sh
./test_hello-world.sh
./test_version.sh

版本发布

• 最新版本：ekleinod/mkdocs-material:latest
• 命名方案：
  1. 内部版本+mkdocs版本：ekleinod/mkdocs-material:<内部版本>-<mkdocs版本>（如1.0.1-8.1.2）
  2. 独立内部版本：ekleinod/mkdocs-material:<主>.<次>.<补丁>（如1.0.1）

本地构建

bash
git clone https://gitlab.com/etg-docker/mkdocs-material.git
cd mkdocs-material/image
./build_image.sh

Git仓库规范

遵循稳定主线分支模型：

• main分支为稳定主线，确保可编译、无测试错误；
• 功能开发用功能分支，发布收尾用特殊分支；
• 版本以主线分支的分支形式创建，打标签（含补丁及附加标识如rc1）；
• 补丁在对应版本分支修改，次要版本用独立分支。

版权信息

版权所有 2021-2024 Ekkart Kleinod <***>
本程序基于GNU通用公共许可证v3或后续版本分发，详情见COPYING文件。
你可自由分发、修改本程序，但需保留原许可证条款。