目录是显示在左侧的文档列表
。它用一组层级结构来表示
_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
完成这些更改后,您可以提交相应更改以供审核。