Skip to content

快速开始 ​

这是一个示例项目,用来演示目录结构、侧边栏生成与排序规则。确认没问题后可以直接删掉这个目录, 同时在 hub-v2/.vitepress/config.mts 的 ENTRIES 里删掉 example 那一行。

目录结构 ​

example/
├── index.md          ← 你正在读的这页(目录首页,侧边栏分组的落地页)
├── 01-示例文档.md     ← order: 2
└── 00-快速开始/
    └── index.md      ← 子目录 = 可折叠分组

侧边栏是怎么来的 ​

config.mts 里的 buildTree() 递归扫描项目目录:

  • 子目录 → 可折叠分组
  • 目录里的松散 .md → 分组内的页面项
  • 每项标题取文件首个 # 标题
  • 排序读 frontmatter 的 order(缺省 9999,排最后)

不需要手写 sidebar 配置。

下一步 ​

去看 示例文档,里面有 frontmatter、Mermaid、代码块、表格的写法示例。