更新網站導覽和 TOC 檔案

目錄會列出顯示在 fuchsia.dev 所有頁面左側的文件清單,由一組階層的 _toc.yaml 檔案表示。頂層 _toc.yaml 檔案為 _toc.yaml

如果將新文件新增至 fuchsia.dev,或是在網站內移動現有說明文件,則必須變更 _toc.yaml 檔案中定義的網站導覽功能。這些檔案位於文件檔案的相同目錄或父項目錄中。

現有文件

如何變更現有文件的說明文件導覽面板:

  1. 在原始碼樹狀結構中,找出文件對應的 _toc.yaml 檔案。

    舉例來說,如要修改 Zircon 概念頁面的導覽面板,您可以看到同一個目錄中有一個 _toc.yaml 檔案。

  2. 編輯 _toc.yaml 檔案。您必須在 _toc.yaml 檔案中指定文件的發布位置,而非 Fuchsia 原始碼中的實際路徑。請參閱 _toc.yaml 參考資料

新增文件

如何為新文件新增導覽功能:

  1. 找出文件最接近的 _toc.yaml 檔案。如果您建立文件的目錄有 _toc.yaml 檔案,請使用該檔案。否則,請瀏覽父項目錄,直到找出最近的 _toc.yaml 檔案為止。

  2. 編輯 _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
    

完成這些變更後,您就可以將變更送審。