zhezack/mkdocs-material

镜像概述

本镜像为Material for MkDocs的Docker化版本，基于Material Design设计风格，用于快速生成静态文档网站。它提供简洁美观的界面和丰富功能，帮助用户高效构建专业的文档站点。

核心功能

• 响应式布局：适配手机、平板、电脑等各类设备，确保文档阅读体验一致。
• 自定义主题：支持修改主色调、强调色、字体、favicon和logo，满足个性化需求。
• 智能搜索：通过快捷键（F/S）访问搜索界面，支持结果分组、关键词高亮和懒加载。
• 工具集成：可对接Google Analytics、Disqus评论系统和GitHub，扩展站点功能。
• 本地化支持：通过主题扩展轻松实现多语言文档。

使用场景

• 开源项目文档的编写与发布
• 企业内部技术手册或产品说明书制作
• 个人博客或知识分享站点搭建
• 团队协作的文档管理平台

配置说明

1. 在项目的mkdocs.yml文件中添加主题配置：

yaml
theme: 'material'

2. 额外配置示例（自定义颜色和字体）：

yaml
theme:
  name: 'material'
  palette:
    primary: 'indigo'
    accent: 'pink'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'

Docker部署示例

单容器运行

bash
docker run -d -p 8000:8000 -v $(pwd)/docs:/docs docker.xuanyuan.run/zhezack/mkdocs-material

说明：本地docs目录挂载到容器，访问http://localhost:8000查看文档站点。

Docker Compose示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  mkdocs:
    image: docker.xuanyuan.run/zhezack/mkdocs-material
    ports:
      - "8000:8000"
    volumes:
      - ./docs:/docs

启动命令：

bash
docker-compose up -d