Skip to content

本站 - 结构

走到这一步,你项目 docs 根目录下现在已经拥有了若干个包含源文件的目录文档。以下是针对 Teek 主题文档中介绍不是特别明确,或者提供多种配置选项的情形,本站点选择使用的配置方法。

目录结构

  • 最顶:00 编号预留给二级和二级以上文件夹的目录页,例如 00.目录.md
  • 中部:在给文件夹下的 Markdown 文件使用数字编号 0102 时,不要 使用重复的数字,否则会有重复覆盖和警告
  • 最底:如果文件夹下存在 index.md 文件,在生成侧边栏时,这个文档会自动排在最顶部(第一位)

特殊目录

  • @pages
  • @fragment
  • /目录页/

关于目录页,说多两句:

docs 根目录下,创建一个 /00.目录页/ 一级目录,专门用于存放其他一级文件夹的目录页。鉴于站点构建前期,我们的一级文件夹可能存在序号变化的情况,这样,保存于 /00.目录页/ 下面的各个页面只需按照实际进行更新即可。

命名约定