Skip to content

目录结构说明

推荐完整结构如下(除必须文件外均为可选)。详见 快速开始 了解必须的 3 个文件。

推荐目录结构

templates/
└── my-theme/                 # 模板 ID = 目录名
    ├── config.yaml           # 必须:模板元数据
    ├── routes.yaml           # 可选:覆盖或新增路由(title、description、数据提供器)
    ├── layout.html           # 必须:布局模板
    ├── home.html             # 必须:至少一个页面,对应 /
    ├── pricing.html          # 可选:例如 /pricing
    ├── products/             # 可选:子目录 = 多级路由
    │   └── storage.html      # → /products/storage
    ├── docs_list.html        # 可选:有 docs/ 时,文档列表页
    ├── docs_detail.html      # 可选:有 docs/ 时,文档详情页
    ├── docs/                 # 可选:文档中心
    │   ├── quickstart/
    │   │   ├── _meta.yaml    # 可选:分类显示名、排序、文档顺序
    │   │   └── install.md
    │   └── deploy/
    │       └── docker.md
    ├── preview.png           # 可选:预览图,在后台模板选择中展示
    └── static/               # 可选:静态资源
        └── css/
            └── style.css

路由自动发现

  • layout.html、以 _ 开头的文件、static/ 目录外,所有 .html 文件会按路径自动生成路由。
  • home.htmlindex.html 对应 /pricing.html 对应 /pricingproducts/storage.html 对应 /products/storage
  • routes.yaml 可覆盖某路由的 title、description,或指定数据提供器,见 config.yaml 与 routes.yaml