目錄是指顯示在左側的文件清單
所有網頁的 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
完成這些變更後,您就可以將變更送審。