这是一个基于 MkDocs 和 Material for MkDocs 主题的文档站点模板，适合初学者快速上手并创建自己的文档网站。

• ✨ 现代化的 Material Design 风格
• 🌓 支持亮色/暗色主题切换
• 🔍 强大的全文搜索功能
• 📱 完全响应式设计
• 🎨 丰富的 Markdown 扩展
• 📊 支持 Mermaid 图表
• 💻 代码高亮和复制功能
• 🌐 中文界面支持

• Python 3.8 或更高版本
• pip（Python 包管理器）

1. 克隆仓库：

   git clone <repository-url>
   cd mkdocs-docs-material-theme-demo
   

2. 创建虚拟环境：

   python3 -m venv venv
   source venv/bin/activate  # Linux/macOS
   # 或
   venv\Scripts\activate  # Windows
   

3. 安装依赖：

   pip install -r requirements.txt
   

启动开发服务器：

mkdocs serve

然后在浏览器中访问 http://127.0.0.1:8000

构建静态站点文件：

mkdocs build

生成的文件将位于 site/ 目录下。

mkdocs-docs-material-theme-demo/
├── docs/                      # 文档源文件
│   ├── index.md              # 首页
│   ├── getting-started/      # 入门指南
│   │   ├── installation.md   # 安装指南
│   │   └── quickstart.md     # 快速开始
│   ├── user-guide/           # 用户指南
│   │   ├── writing.md        # 编写文档
│   │   └── styling.md        # 样式定制
│   └── about/                # 关于
│       ├── license.md        # 许可证
│       └── changelog.md      # 更新日志
├── mkdocs.yml                # MkDocs 配置文件
├── requirements.txt          # Python 依赖
├── .gitignore               # Git 忽略文件
└── README.md                # 本文件

主要配置在 mkdocs.yml 文件中：

• 主题配置：颜色、字体、图标等
• 导航结构：页面组织和菜单
• Markdown 扩展：启用的功能和插件
• 搜索配置：搜索功能设置

本演示站点展示了以下功能：

• 提示框（Admonitions）
• 代码高亮
• 选项卡
• 任务列表
• 表格
• 脚注
• 数学公式
• Mermaid 图表

• 深色模式切换
• 导航标签
• 搜索建议
• 代码复制按钮
• 返回顶部按钮
• 响应式布局

使用 MkDocs 内置命令部署到 GitHub Pages：

mkdocs gh-deploy

构建后的 site/ 目录可以部署到任何静态网站托管服务：

• Netlify
• Vercel
• GitLab Pages
• AWS S3
• Azure Static Web Apps

详细文档请访问站点的以下页面：

• 安装指南
• 快速开始
• 编写文档
• 样式定制

主要依赖包：

• mkdocs (1.6.1)
• mkdocs-material (9.7.0)
• pymdown-extensions (10.17+)
• pygments (2.19+)

完整依赖列表请查看 requirements.txt。

• MkDocs 官方文档
• Material for MkDocs 文档
• Markdown 语法指南
• Python Markdown 扩展
• PyMdown Extensions

The Unlicense

---

祝你写作愉快！ 🎉

如有问题，欢迎查阅 MkDocs 官方文档 和 Material for MkDocs 文档 或提交 Issue。