acyort-toc

Toc Helper for AcyOrt

Install

$ npm i acyort-toc -S

Usage

# config.yml
# ...
plugins:
  - acyort-toc
# ...

<!-- post.html -->
<div class="toc">
{{ _toc(page.raw) }}
</div>

Text slugify API

const { slugify } = require('acyort-toc')

slugify('I ♥ Dogs') // i-love-dogs
slugify('这是@一#段$；¥中#文「【') // 这是-一-段-中-文

you should slugify markdown heading id

const { slugify } = require('acyort-toc')

acyort.renderer.render('markdown', body, { getHeadingId: slugify })

Advanced

module.exports = (acyort) => {
  const { helper } = acyort
  const toc = helper.get('_toc')

  toc('markdown raw string')
}

Test

$ npm i acyort -g

$ npm t