Skip to content

Commit

Permalink
使用方法についてを追加
Browse files Browse the repository at this point in the history
  • Loading branch information
TakamiChie committed Jul 24, 2019
1 parent 7c9292f commit 219759e
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,18 @@
記事のcontentを解析し、<ol>タグおよび<li>タグで目次を生成します。
pico-headerlvmodプラグインとの並行利用も念頭に入れて作成されているため、プラグインの呼び出し順番を考慮することなく、そのまま利用可能です。

## 使用方法

1. プラグインをダウンロードし、`plugins`フォルダに`pico_toc`というフォルダ名で保存する
2. `config/config.yml`に、`Pico_TOC.enabled = true`という行を書き加える

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

なし

## 追加するTwig変数

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

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

Expand Down

0 comments on commit 219759e

Please sign in to comment.