mkdocs/docs/index.md

欢迎来到个人知识库

这是一个基于 MkDocs Material 的个人技术文档和知识管理平台。

📚 功能特性

• 📝 Markdown 支持: 使用 Markdown 编写文档，简单易用
• 🎨 Material 主题: 美观现代的 Material Design 界面
• 🔍 全文搜索: 快速查找所需内容
• 📱 响应式设计: 支持各种设备访问
• 🌙 深色模式: 支持浅色/深色主题切换
• 📊 代码高亮: 支持多种编程语言的语法高亮
• 🔗 导航系统: 清晰的文档导航结构

🚀 快速开始

编辑文档

1. 在 docs/ 目录下创建或编辑 Markdown 文件
2. 在 mkdocs.yml 中更新导航配置
3. 保存后，MkDocs 会自动重新加载（开发模式）

添加新文档

1. 在 docs/ 目录下创建新的 .md 文件
2. 在 mkdocs.yml 的 nav 部分添加导航项
3. 重启服务或等待自动重载

构建静态站点

# 进入容器执行构建
docker exec -it mkdocs mkdocs build

# 或使用 docker-compose
docker-compose exec mkdocs mkdocs build

📖 文档结构

docs/
├── index.md                    # 首页
├── 开发指南/                   # 开发相关文档
├── DevOps平台/                 # DevOps 工具使用指南
├── 技术文档/                   # 技术架构和 API 文档
└── 学习笔记/                   # 学习笔记和总结

🔗 相关链接

• MkDocs 官方文档
• Material for MkDocs
• Markdown 语法指南

💡 使用技巧

1. 代码块: 使用三个反引号包裹代码，并指定语言
2. 表格: 使用 Markdown 表格语法
3. 图片: 将图片放在 docs/images/ 目录，使用相对路径引用
4. 数学公式: 支持 LaTeX 数学公式（需要启用相应插件）
5. 流程图: 支持 Mermaid 流程图（已配置）

---

开始编写你的文档吧！ 📝