分类管理
如何组织文档目录结构和管理 _meta.json 导航配置
Hey，同学！想让文档目录井井有条吗？这一篇教你如何组织 Docs 的分类体系～ 🗂️
🤔 分类是什么？
在 Docs 中，分类就是文件夹 + 配置文件的组合：
text
content/
├── _meta.json # 根级配置
├── 入门/
│ ├── _meta.json # 本级配置
│ └── quick-start.mdx
└── 进阶/
└── ...
🗂️ 创建分类
1. 新建文件夹
在 content/ 下创建文件夹：
bash
mkdir -p content/教程
mkdir -p content/参考
2. 添加文档
在文件夹中创建 .mdx 文件：
text
content/教程/
├── _meta.json
├── 01-安装.mdx
├── 02-配置.mdx
└── 03-使用.mdx
3. 配置 _meta.json
在文件夹中创建 _meta.json：
json
{
"01-install": "安装",
"02-config": "配置",
"03-usage": "使用"
}
⚙️ _meta.json 配置
基本用法
json
{
"filename": "显示名称"
}
排序功能
使用数字前缀：
json
{
"01-intro": "介绍",
"02-install": "安装",
"03-usage": "使用"
}
显示顺序就是：介绍 → 安装 → 使用
隐藏文件
如果想显示但不在导航中：
json
{
"intro": { "title": "介绍", "display": "hidden" }
}
📊 分类结构建议
方案一：按主题
text
content/
├── 快速开始/
│ ├── _meta.json
│ └── ...
├── 核心概念/
│ ├── _meta.json
│ └── ...
├── 进阶主题/
│ ├── _meta.json
│ └── ...
└── 参考资料/
├── _meta.json
└── ...
方案二：按功能
text
content/
├── API/
│ ├── _meta.json
│ ├── overview.mdx
│ ├── authentication.mdx
│ └── endpoints/
│ ├── _meta.json
│ └── ...
└── 指南/
└── ...
🔧 高级配置
多级分类
支持多级嵌套：
text
content/
├── 一级/
│ ├── _meta.json
│ └── 二级/
│ ├── _meta.json
│ └── ...
外部链接
可以在 _meta.json 中添加外部链接：
json
{
"github": {
"title": "GitHub",
"href": "https://github.com/xxx",
"newWindow": true
}
}
💡 最佳实践
1. 层级不要过深
建议最多 3 级：
- 1 级：主题（如「入门」「进阶」）
- 2 级：章节（如「安装」「配置」）
- 3 级：具体内容
2. 命名一致性
- 全部中文？还是英文？
- 数字前缀用 01、02 还是 1、2？
提前定好规范！
3. 定期整理
- 检查是否有「孤儿文档」（没有被任何分类引用）
- 合并相似分类
- 删除过时内容
📋 示例：完整结构
text
content/
├── _meta.json
│
├── 快速开始/
│ ├── _meta.json
│ ├── 01-介绍.mdx
│ ├── 02-安装.mdx
│ └── 03-快速开始.mdx
│
├── 基础/
│ ├── _meta.json
│ ├── 01-概念.mdx
│ ├── 02-组件.mdx
│ └── 03-样式.mdx
│
├── 进阶/
│ ├── _meta.json
│ ├── 01-性能优化.mdx
│ ├── 02-自定义.mdx
│ └── 03-部署.mdx
│
└── 参考/
├── _meta.json
├── 配置.mdx
└── API.mdx
🔗 下一步
🗂️ 好的分类让「知识」变成「知识库」！