sommerfeldio/mkdocs

sommerfeldio/mkdocs

镜像概述

本镜像基于https://hub.docker.com/r/squidfunk/mkdocs-material%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%89%A9%E5%B1%95%E4%BA%86https://pypi.org/project/mkdocs-kroki-plugin%EF%BC%8C%E6%94%AF%E6%8C%81%E9%80%9A%E8%BF%87https://kroki.io%E6%B8%B2%E6%9F%93%E5%9B%BE%E8%A1%A8%E4%B8%8E%E5%8F%AF%E8%A7%86%E5%8C%96%E5%86%85%E5%AE%B9%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%94%9F%E6%88%90%E9%9D%99%E6%80%81%E6%96%87%E6%A1%A3%E7%AB%99%E7%82%B9%EF%BC%8C%E4%B8%8D%E9%80%82%E7%94%A8%E4%BA%8E%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E7%9A%84%E5%AE%9E%E6%97%B6Web%E6%9C%8D%E5%8A%A1%E3%80%82

核心功能

1. 基于Material for MkDocs构建静态文档站点，支持Markdown内容转换
2. 集成mkdocs-kroki-plugin，可生成流程图、架构图等多种可视化图表
3. 提供开发预览服务器，方便文档编写过程中的实时预览
4. 支持CI/CD流水线中自动化构建静态文档

使用场景

• 文档开发阶段：通过开发服务器实时预览文档效果
• CI/CD流程：自动化构建静态文档站点并部署到生产环境（如Nginx、Apache）
• 团队协作：统一文档构建环境，确保输出一致性

配置说明

Docker Compose示例

yaml
services:
  docs-build:
    container_name: docs-build
    image: docker.xuanyuan.run/&docs-image sommerfeldio/mkdocs:latest
    volumes: &volumes
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
      - .:/workspaces/your-project
    working_dir: &default-workdir /workspaces/your-project
    command: build

  docs-dev-server:
    container_name: docs-dev-server
    image: docker.xuanyuan.run/*docs-image
    volumes: *volumes
    working_dir: *default-workdir
    ports:
      - 3080:8000

使用注意事项

• 开发服务器仅用于文档开发预览，不建议用于生产环境
• 生产环境需使用build命令生成静态站点，再通过Nginx等Web服务器部署
• 详细配置可参考：
  • https://squidfunk.github.io/mkdocs-material/getting-started
  • https://pypi.org/project/mkdocs-kroki-plugin

相关链接

• https://hub.docker.com/r/sommerfeldio/mkdocs
• https://github.com/sommerfeld-io/container-images/tree/main/components/mkdocs
• https://github.com/sommerfeld-io/.github/blob/main/CONTRIBUTING.md
• https://sommerfeld-io.github.io/container-images

许可证

本镜像继承自GitHub仓库的https://sommerfeld-io.github.io/container-images/license%EF%BC%8C%E4%B8%8E%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8Fhttps://github.com/squidfunk/mkdocs-material/blob/master/LICENSE%E7%9A%84MIT%E8%AE%B8%E5%8F%AF%E8%AF%81%E5%85%BC%E5%AE%B9%E3%80%82