Jekyll-toc

Tags: gem-based-plugins , table-of-contents , toc

目次を生成するJekyllプラグイン

• Homepage (github.com) [EN]
• Document (rubydoc.info) [EN]

目次を生成するJekyllプラグイン

インストール

1. Gemfileを編集

   # Gemfile
   group :jekyll_plugins do
     gem 'jekyll-toc'
   end
   

2. _config.ymlを編集

   # _config.yml
   plugins:
     - jekyll-toc
   

3. Pluginのインストール

   bundle install
   

4. 目次を表示させたい投稿のFront Matterで、toc: trueを設定します。

   ---
   layout: post
   title: "Welcome to Jekyll!"
   toc: true
   ---
   

使い方

このプラグインで提供されるLiquidフィルターは3種類あります。 例えばテンプレートでcontents変数に適用します。

デフォルト設定

toc:
  min_level: 1
  max_level: 6
  no_toc_section_class: no_toc_section
  list_class: section-nav
  sublist_class: ''
  item_class: toc-entry
  item_prefix: toc-

関連ページ

• 目次 (TOC) - Jekyllの目次 (TOC) 生成について

ブログ記事

下記に掲載を希望される方はご連絡ください (詳細)

Back to top