目录结构说明
.
├── docs/ # 所有 Markdown 文档
│ ├── index.md # 首页
│ ├── guide/ # 指南类文章
│ └── standards/ # 规范类文章
├── mkdocs.yml # 站点配置
└── README.md # 仓库说明
mkdocs.yml 关键配置
site_name:文档站标题
nav:导航结构,对应 docs/ 中的 Markdown 文件
theme:主题设置,这里使用 material
markdown_extensions:启用的 Markdown 扩展和语法增强
plugins:扩展功能,如搜索、标签等
文档命名规范
- 文件名一律使用小写字母与连字符,例如
data-import.md
- 目录按主题分类,深度不建议超过三级
- 每篇文章需包含
# 级别的主标题,并在开头提供背景或摘要
静态资源放置
- 图片、附件等资源建议放置于
docs/assets/ 下
- 引用资源时使用相对路径,例如

自定义主题资源
- 需要覆盖主题文件时,可创建
overrides/ 目录并在 mkdocs.yml 中通过 theme.custom_dir 指定
- 建议将样式覆盖集中在
docs/assets/stylesheets/ 中,便于统一管理