1 unstable release
0.1.1 | Mar 4, 2021 |
---|
#9 in #toc
9KB
195 lines
yarner-toc
A Yarner plugin to generate a Table of Content.
Installation
Binaries
- Download the latest binaries for your platform
- Unzip somewhere
- Add the parent directory of the executable to your
PATH
environmental variable
Using cargo
> cargo install yarner-toc
Usage
Add a section plugin.toc
to your Yarner.toml
:
[plugin.toc]
Options
The plugin allows for different options, which are all optional:
[plugin.toc]
placeholder = "[[_TOC_]]"
min-level = 2
max-level = 5
Option | Details | Default |
---|---|---|
placeholder |
Placeholder to replace with the TOC | [[_TOC_]] |
min-level |
Minimum heading level to include | 2 |
max-level |
Maximum heading level to include | 5 |
Dependencies
~1.7–2.7MB
~54K SLoC