備忘録

【Hugo】目次(Table of Contents)を作る

前提

Hugo: v0.125.4

TableOfContents

以下のメソッドを呼ぶだけで目次が作れる

{{ .TableOfContents }}

このページの場合、以下のhtmlが出力される

<nav id="TableOfContents">
  <ul>
    <li><a href="#前提">前提</a></li>
    <li><a href="#tableofcontents">TableOfContents</a></li>
  </ul>
</nav>

configでどのレベルまで目次に出力するか設定できる。

markup:
  tableOfContents:
    endLevel: 2
    ordered: false
    startLevel: 2

関連記事

  • 【Hugo】MarkdownやソースコードをShortcodes内に記載する方法
    前提 Hugo: v0.125.4 対応内容 MarkdownをShortcode内に記載したときに、期待した結果が得られないことがあったので整理。 対応する方法としては、
  • 【Hugo】Hugoの基本的な文法
    前提 Hugo: v0.125.4 変数 定義 {{ $foo := "foo" }} 代入 {{ $foo = "bar" }} テンプレート内での使用 <p>{{ $foo }}</p> 比較 Eq arg1 == arg2 {{ eq 1 1 }} # true {{ eq 1 2 }} # false {{ eq "foo" "foo" }} # true {{ eq "foo" "bar" }} # false 参考
  • 【Hugo】Hugoの環境構築
    前提 環境: Windows Hugo: v0.125.4 インストール バイナリをダウンロードして配置 Githubからバイナリをダウンロード Releases latest ダウンロードしたファイルを解凍し、任意の
  • 【Hugo】HugoでSass(SCSS)を使う
    前提 環境: Windows Hugo: v0.125.4 Dart Sassのインストール Hugo ExtendedにはLibSassが含まれているが、非推奨となっているため、Dart Sassをイン
  • 【SCSS】StylelintとPrettierを使ってSCSSの自動整形
    Stylelint バージョン 16.4.0 インストール npm install --save-dev stylelint stylelint-config-standard-scss stylelint-config-recess-order 設定ファイル .stylelintrc.yaml extends: - stylelint-config-standard-scss - stylelint-config-recess-order - stylelint-prettier/recommended rules: block-no-empty: true no-duplicate-selectors: null Prettier バージョン 3.2.5 インストール npm install --save-dev prettier stylelint-prettier 設定ファイル .prettierrc.yaml tabWidth: 4 Style