Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jdsteinbach/eleventy-plugin-toc
11ty plugin to generate a TOC from page content
https://github.com/jdsteinbach/eleventy-plugin-toc
eleventy eleventy-plugin hacktoberfest javascript
Last synced: 1 day ago
JSON representation
11ty plugin to generate a TOC from page content
- Host: GitHub
- URL: https://github.com/jdsteinbach/eleventy-plugin-toc
- Owner: jdsteinbach
- Created: 2018-06-19T00:19:59.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-08T19:55:14.000Z (4 months ago)
- Last Synced: 2025-01-11T05:13:12.714Z (8 days ago)
- Topics: eleventy, eleventy-plugin, hacktoberfest, javascript
- Language: JavaScript
- Homepage:
- Size: 167 KB
- Stars: 64
- Watchers: 4
- Forks: 19
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - jdsteinbach/eleventy-plugin-toc - 11ty plugin to generate a TOC from page content (javascript)
README
# eleventy-plugin-toc
This Eleventy plugin will generate a TOC from page content using an Eleventy filter.
## Default Options
```js
{
tags: ['h2', 'h3', 'h4'], // which heading tags are selected headings must each have an ID attribute
wrapper: 'nav', // element to put around the root `ol`/`ul`
wrapperClass: 'toc', // class for the element around the root `ol`/`ul`
ul: false, // if to use `ul` instead of `ol`
flat: false, // if subheadings should appear as child of parent or as a sibling
}
```
## Usage
### 1. Install the plugin
```sh
npm i --save eleventy-plugin-toc
```
### 2. Make sure your headings have anchor IDs
**Your heading elements must have `id`s before this plugin will create a TOC.** If there aren't `id`s on your headings, there will be no anchors for this plugin to link to.
I use [`markdown-it-anchor`](https://www.npmjs.com/package/markdown-it-anchor) to add those `id`s to the headings: [Eleventy config example](https://github.com/jdsteinbach/jdsteinbach.github.io/blob/blog/.eleventy.js)
```js
// .eleventy.js
const markdownIt = require('markdown-it')
const markdownItAnchor = require('markdown-it-anchor')
module.exports = eleventyConfig => {
// Markdown
eleventyConfig.setLibrary(
'md',
markdownIt().use(markdownItAnchor)
)
// ... your other Eleventy config options
}
```
### 3. Add this plugin to your Eleventy config
```js
// .eleventy.js
const pluginTOC = require('eleventy-plugin-toc')
module.exports = function (eleventyConfig) {
eleventyConfig.addPlugin(pluginTOC)
}
```
#### 3.1 You can override the default plugin options
```js
module.exports = function (eleventyConfig) {
eleventyConfig.addPlugin(pluginTOC, {
tags: ['h2', 'h3'],
wrapper: 'div'
})
}
```
### 4. Use the filter in your layout template(s)
Because Eleventy only provides the `content` variable to layout templates (not to content files), you'll need to put this markup in a layout template:
```liquid
{{ content }}
{{ content | toc }}
```
If you're using Nunjucks, include the `safe` filter:
```njk
{{ content | safe }}
{{ content | toc | safe }}
```
If you want to conditionally render a wrapper element, the filter will return `undefined` when no markup is generated:
```liquid
{% if content | toc %}
{{ content | toc }}
{% endif %}
```
### 5. Override default options if necessary
Pass a stringified JSON object (must be `JSON.parse()`-able) as an option for in your template. Because this is an object, you only need to include the key-value pairs you need to override; [defaults](#default-options) will be preserved.
```liquid
{{ content | toc: '{"tags":["h2","h3"],"wrapper":"div","wrapperClass":"content-tableau"}' }}
```
## Options
| Name | Default Value | Type | Purpose |
| --- | --- | --- | --- |
| tags | `['h2', 'h3', 'h4']` | array of strings | which heading tags are used to generate the table of contents |
| wrapper | `'nav'` | string | tag of element wrapping toc lists; `''` removes wrapper element |
| wrapperClass | `'toc'` | string | `class` on element wrapping toc lists |
| wrapperLabel | `undefined` | string | `aria-label` on element wrapping toc lists |
| ul | `false` | boolean | lists are `ul` if true, `ol` if `false` |
| flat | `false` | boolean | use flat list if `true`; use nested lists if false |
## Roadmap
- [ ] Some tests would be nice