Appearance
VitePress 笔记目录设计示例
这篇内容用于演示“标准说明型文章”的写法。重点不是结论本身,而是如何把背景、原则和具体结构表达清楚。
适用场景
当一个站点会长期积累很多 Markdown 内容时,目录结构本身就会成为主要导航方式。此时文章应该先说明适用场景,再给出组织原则。
设计原则
建议优先保持以下原则:
- 目录名稳定,不频繁改名
- 一级分类尽量少而清晰
- 层级不要超过四层
- 一篇笔记只聚焦一个主题
示例结构
下面是一种常见的结构:
text
docs/
├─ frontend/
│ ├─ index.md
│ ├─ vitepress-note-structure.md
│ └─ common-utility-snippets.md
└─ memo/
└─ content-writing-workflow.md这样写的好处
这种结构对站点和写作者都更友好:
- 站点可以更容易生成侧边栏
- 读者更容易理解内容边界
- 作者在新增内容时更容易判断归类
收尾方式
说明型文章最后最好用一小段话收尾,明确这份内容的使用方式。例如:如果未来需要新增前端记录,优先沿用这套目录判断规则,而不是重新定义分类。