HEXO の投稿に目次機能を追加する

HEXO でブログ記事に目次を追加します。
標準の機能もあるようだけど、プラグインを使用してみます。

↑設置する目次はこれです。


プラグイン配布元

hexo-toc GitHub
https://github.com/bubkoo/hexo-toc

インストール

bash
1
$ npm install hexo-toc --save

設定

_config.icarus.yml

_config.icarus.yml
1
2
3
4
5
6
7
8
toc:
maxdepth: 3
class: toc
slugify: uslug
anchor:
position: after
symbol: "#"
style: header-anchor
  • maxdepth : 目次の最大の深さ
  • class : toc の CSSクラス(デフォルト:false)
  • slugfy : uslug または transliteration
  • decodeEntities : HTMLエンコード設定(デフォルト:false)
  • anchor : アンカータグをつけるかどうか(デフォルト:false)
    • position : アンカーをどこにつけるか。 before または after (デフォルト:after)
    • symbol : アンカーとしたいシンボル(デフォルト:#)
    • style : アンカーのCSSクラス (デフォルト:header-anchor)

設置

記事内の目次を表示したい場所に、 <! -- toc --> を配置。
見出しタグ(hタグ)から自動的に見出しを出力してくれます。

[YOURPOST].md
1
<!-- toc -->




HEXO の投稿に目次機能を追加する

https://fennote.fareastnoise.com/2022/03/04/toc/

Author

FEN

Posted on

2022-03-04

Updated on

2022-04-07

Licensed under

コメント