核心用法
本技能为 Markdown 笔记系统提供完整的管理框架,主要应用于以下场景:
- 新建笔记:按 "导航→分组→文档" 三级结构创建,强制使用 kebab-case 文件名与 Title Case 显示名
- 目录维护:通过
index.md建立分组索引,通过 VitePress sidebar 配置实现侧边栏导航 - 模板套用:内置 knowledge/guide/experience 三种文档类型,强制要求 YAML frontmatter + H1 标题 + 参考资料三部分结构
显著优点
1. 结构清晰:三级文件夹体系(导航/分组/文档)与显式映射规则,避免笔记堆积混乱
2. 双语分离:导航分组用英文保证 URL 友好,内容用中文保证可读性
3. 工具友好:基于 VitePress 设计,天然支持静态站点生成与侧边栏自动生成
4. 强制约束:30 字符标题限制、参考资料必填、sidebar text 必须与 H1 一致等规则减少维护负担
潜在局限
- 耦合度高:与 VitePress 深度绑定,迁移至其他工具(如 Docusaurus、Obsidian Publish)需重写配置
- 学习成本:kebab-case/Title Case/中文 H1 的三层映射关系对新用户不够直观
- 人工同步:sidebar 配置与笔记 H1 需手动保持一致,无自动化校验机制
- 场景单一:面向个人/小型团队知识库,缺乏多用户权限、版本对比等企业级功能
适合人群
- 使用 VitePress 搭建个人博客或团队 Wiki 的开发者
- 追求 "约定优于配置"、愿为长期可维护性接受前期约束的笔记重度用户
- 需要将零散 Markdown 整理为结构化知识库的转型期用户
常规风险
- 命名不一致:若未严格执行 check-list,易出现 URL 与侧边栏显示不符的断裂体验
- 配置遗漏:新增笔记后忘记更新 sidebar 会导致页面 "存在但不可达"
- 中文字符超限:30 字符标题限制对复杂技术概念可能不足,需缩写或拆分