yarner-toc
| Crates.io | yarner-toc |
| lib.rs | yarner-toc |
| version | 0.1.1 |
| created_at | 2021-03-04 23:32:26.196683+00 |
| updated_at | 2021-03-04 23:32:26.196683+00 |
| description | A Yarner plugin plugin to generate a Table of Content |
| homepage | https://github.com/mlange-42/yarner-toc/ |
| repository | https://github.com/mlange-42/yarner-toc/ |
| max_upload_size | |
| id | 363972 |
| size | 13,322 |
Martin Lange (mlange-42)
documentation
README
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
PATHenvironmental 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 |