https://github.com/acyortjs/acyort-toc
Toc Helper for AcyOrt
https://github.com/acyortjs/acyort-toc
Last synced: about 1 month ago
JSON representation
Toc Helper for AcyOrt
- Host: GitHub
- URL: https://github.com/acyortjs/acyort-toc
- Owner: acyortjs
- License: mit
- Created: 2018-01-18T09:19:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-15T08:43:37.000Z (about 7 years ago)
- Last Synced: 2025-09-19T21:35:03.454Z (10 months ago)
- Language: JavaScript
- Size: 83 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# acyort-toc
Toc Helper for [AcyOrt](https://github.com/acyortjs/acyort)
## Install
```bash
$ npm i acyort-toc -S
```
## Usage
```yml
# config.yml
# ...
plugins:
- acyort-toc
# ...
```
```html
{{ _toc(page.raw) }}
```
Text slugify API
```js
const { slugify } = require('acyort-toc')
slugify('I ♥ Dogs') // i-love-dogs
slugify('这是@一#段$；¥中#文「【') // 这是-一-段-中-文
```
**you should slugify markdown heading id**
```js
const { slugify } = require('acyort-toc')
acyort.renderer.render('markdown', body, { getHeadingId: slugify })
```
### Advanced
```js
module.exports = (acyort) => {
const { helper } = acyort
const toc = helper.get('_toc')
toc('markdown raw string')
}
```
## Test
```bash
$ npm i acyort -g
$ npm t
```