tiryoh/mkdocs-builder

docker-mkdocs-builder

用于构建MkDocs文档的Docker镜像，可帮助用户快速搭建本地文档预览服务器，简化文档开发流程。

核心功能和特性

• 支持本地服务器实时预览MkDocs文档渲染效果
• 提供两种基础镜像版本：基于Debian和基于Alpine，满足不同轻量化需求
• 即开即用，无需手动配置MkDocs环境依赖

使用场景和适用范围

适用于MkDocs文档开发过程中的本地预览环节，帮助开发者在编写文档时即时查看排版效果，提升文档创作效率，尤其适合需要快速迭代的文档项目。

使用方法和配置说明

本地预览服务器启动

在MkDocs项目根目录下执行以下命令，启动本地文档预览服务器：

bash
docker run --rm -p 8000:8000 -v ${PWD}:/docs tiryoh/mkdocs-builder:alpine

服务器启动后，通过访问 http://127.0.0.1:8000 即可查看文档内容。

（高级）本地构建Docker镜像

如需在本地构建镜像，可执行以下命令：

bash
# 构建基于Debian的镜像
docker build -t tiryoh/mkdocs-builder:debian -f debian/Dockerfile .

# 构建基于Alpine的镜像
docker build -t tiryoh/mkdocs-builder:alpine -f alpine/Dockerfile .

相关项目

• https://github.com/Tiryoh/actions-mkdocs
  • 用于MkDocs的GitHub Actions工作流配置

许可证

Copyright (c) 2020-2023 Daisuke Sato

本仓库采用MIT许可证授权，详见LICENSE。除非另有说明，本仓库中所有内容均采用MIT许可证授权。

致谢

本仓库包含第三方库和软件，详见THIRD-PARTY-NOTICES.md。