Pico Plugin: 記事の段落から、自動的に見出しリスト(Table Of Contents)を生成するプラグイン
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
LICENSE
README.md
pico_toc.php

README.md

pico-toc

記事の段落から、自動的に見出しリスト(Table Of Contents)を生成するプラグイン

記事のcontentを解析し、<ol>タグおよび<li>タグで目次を生成します。 pico-headerlvmodプラグインとの並行利用も念頭に入れて作成されているため、プラグインの呼び出し順番を考慮することなく、そのまま利用可能です。

テンプレートに追加する値

なし

追加するTwig変数

  • TOC:記事内のもくじを示す、HTMLスニペット

テンプレート内での利用例

{% if TOC %}
  <div class="toc panel panel-info">
    <h3 class="panel-heading">もくじ</h3>
    <div class="panel-body">
      {{TOC}}
    </div>
  </div>
{% endif %}

コンフィグオプション

なし