目录是显示在 fuchsia.dev 上每个页面左侧的文档列表,由一组分层的 _toc.yaml
文件表示。顶级 _toc.yaml
文件是 _toc.yaml
。
如果您向 fuchsia.dev 添加新文档,或者移动网站内的现有文档,则需要更改 _toc.yaml
文件中定义的网站导航方式。这些文件位于文档文件的同一目录中,或位于一个父目录中。
现有文档
如需更改现有文档的文档导航,请执行以下操作:
在源代码树中找到该文档对应的
_toc.yaml
文件。例如,如果要修改 Zircon 的概念页面的导航,可以看到同一目录中有
_toc.yaml
文件。修改
_toc.yaml
文件。 您必须在_toc.yaml
文件中指定文档的发布位置,而不是在 Fuchsia 源代码中的实际路径。请参阅_toc.yaml
参考文档。
新建文档
要为新文档添加导航,请执行以下操作:
找到距离文档最近的
_toc.yaml
文件。如果创建文档的目录包含_toc.yaml
文件,请使用该文件。如果没有,请浏览父目录,直到找到最近的_toc.yaml
文件。修改
_toc.yaml
文件。 请参阅_toc.yaml
参考文档。
_toc.yaml
参考文档
_toc.yaml
文件可以包含单个条目,也可以包含多个条目的可展开部分:
单个条目
目录导航中的单个条目由相应
_toc.yaml
文件中的标题和路径表示。此外,每个条目也必须像_toc.yaml
中的其他条目一样使用正确的缩进。路径必须符合以下要求:
- 文件路径应该是从项目根目录起的完整路径。例如,
/docs/development/api/cli.md
。 - 目录路径不应包含尾随斜杠,并且目录必须包含名为
README.md
的文件。
例如,如需在 Zircon
concepts.md
页面的相应_toc.yaml
中添加条目,您应添加一个条目:- title: "Kernel concepts" path: /docs/concepts/kernel/concepts.md
- 文件路径应该是从项目根目录起的完整路径。例如,
可展开的部分
可展开部分是可展开的目录内的多个条目组。如需查看示例,请参阅“概念”部分中的可展开部分,例如“网络和图形”。每个可展开的版块的名称左侧都有一个箭头。
您可以使用
section
元素创建一组条目。此外,与_toc.yaml
中的其他条目一样,每个部分也必须使用正确的缩进。然后,您可以向该部分添加单个条目。例如,如需在“系统”目录
_toc.yaml
中添加某个部分,请添加section
组及其对应的条目。这些条目通常来自其他 _toc.yaml 文件:- title: "Zircon kernel" section: - include: /docs/concepts/kernel/_toc.yaml
完成这些更改后,您可以提交更改以供审核。