pengbai/docker-mkdocs

docker-mkdocs

基于Alpine的Python 3.6环境

MkDocs是一个简单的静态网站生成器，专门用于构建项目文档。文档源文件使用Markdown编写，并通过单个YAML配置文件进行配置。

镜像概述

本镜像基于Alpine的Python 3.6环境构建，集成了MkDocs静态网站生成器，默认使用Bootswatch的flatly主题，并预安装了mkdocs-material，可快速构建美观的项目文档网站。

核心功能与特性

• 默认主题：使用Bootswatch的flatly主题，支持轻松切换其他Bootswatch主题（如amelia、cerulean等）
• 预安装组件：已预装mkdocs-material，提供更丰富的文档展示效果
• 工作区设计：项目配置文件（mkdocs.yml）、主题和文档文件位于镜像内的/workspace路径
• 轻量级基础：基于Alpine Linux，镜像体积小，运行高效

使用场景

适用于需要快速构建和部署项目文档的场景，包括但不限于：

• 开源项目文档
• 技术手册和API文档
• 产品说明文档
• 团队内部知识库

使用方法与配置说明

基本运行

直接运行容器，启动MkDocs服务，默认使用示例文档：

bash
docker run -d -p 8000:8000 pengbai/docker-mkdocs

服务启动后，可通过访问http://localhost:8000查看文档网站。

使用本地文档

将本地文档目录挂载到容器的/workspace路径，使用自定义文档生成网站：

bash
docker run -d -p 8000:8000 -v /本地工作目录:/workspace pengbai/docker-mkdocs

其中，/本地工作目录需包含MkDocs项目文件（mkdocs.yml配置文件和docs目录）。

主题切换

默认使用flatly主题，如需切换其他Bootswatch主题，修改项目配置文件mkdocs.yml中的theme字段：

yaml
theme: amelia  # 使用amelia主题

支持的Bootswatch主题列表可参考http://mkdocs.github.io/mkdocs-bootswatch/%E3%80%82