mkdocs/docs/开发指南/项目结构.md

项目结构

目录说明

mkdocs/
├── docker-compose.yml      # Docker Compose 配置文件
├── mkdocs.yml              # MkDocs 配置文件
├── docs/                   # 文档源文件目录
│   ├── index.md           # 首页
│   ├── 开发指南/          # 开发相关文档
│   ├── DevOps平台/        # DevOps 工具文档
│   ├── 技术文档/          # 技术文档
│   └── 学习笔记/          # 学习笔记
└── site/                   # 构建后的静态站点（可选）

配置文件说明

mkdocs.yml

MkDocs 的主配置文件，包含：

• 站点信息（名称、描述、作者等）
• 主题配置
• 插件配置
• 导航结构
• Markdown 扩展

docker-compose.yml

Docker Compose 配置文件，定义：

• 使用的镜像
• 端口映射
• 数据卷挂载
• 环境变量
• 健康检查

文档组织建议

1. 按主题分类: 将相关文档放在同一目录下
2. 命名规范: 使用有意义的文件名
3. 导航清晰: 在 mkdocs.yml 中维护清晰的导航结构
4. 版本控制: 建议使用 Git 管理文档