Skip to content

[RFC] 拆分目录格式 #1002

@diauweb

Description

@diauweb

目前目录是由一个 src/ 下写死的文件 sidebar.yaml 统一维护的。为便于维护,试提出一种新的目录格式。

  1. 目录保存在 docs 目录下,与文档文件同级
  2. 目录按层级拆分为不同文件
  3. 一般使用名称 index.yml

index.yml 应提供一个数组,其中包含当前项其下的子目录和页面。
单项只提供一个字符串时,表示文档的文件名,标题由文档元数据提供;提供一个 只有一项的 K-V Pair 时,K 表示标题,V 表示文件名。
对于子目录,必须提供一个标题。只有子目录文件需要提供文件扩展名按文件搜索,其余的文档路径以Gatsby创建的页面路径为准。

在解析文件名时,以当前 index 文件所在目录为相对目录。文件名前有 / 的以文档目录顶部目录开始解析

例如:

# /index.yml
- 简介: intro/ # equivalent to intro/index.yml
- 语言基础: lang/
- 算法基础: basic/
# /intro/index.yml
- Getting Started: /
- resources
- common-mistakes
- ./common-tricks
- /intro/non-trad/

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions