TableOfContents

TableOfContents 方法在 Page 物件中會返回有序或無序列表,包含頁面內容中的 Markdown ATXsetext 標題。

以下範例代碼:

{{ .TableOfContents }}

會生成以下 HTML:

<nav id="TableOfContents">
  <ul>
    <li><a href="#section-1">Section 1</a>
      <ul>
        <li><a href="#section-11">Section 1.1</a></li>
        <li><a href="#section-12">Section 1.2</a></li>
      </ul>
    </li>
    <li><a href="#section-2">Section 2</a></li>
  </ul>
</nav>

預設情況下,TableOfContents 方法返回的是無序的 2 級和 3 級標題列表。您可以在網站配置中調整此設置:

hugo.
     
markup:
  tableOfContents:
    endLevel: 3
    ordered: false
    startLevel: 2
[markup]
  [markup.tableOfContents]
    endLevel = 3
    ordered = false
    startLevel = 2
{
   "markup": {
      "tableOfContents": {
         "endLevel": 3,
         "ordered": false,
         "startLevel": 2
      }
   }
}