npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@uncenter/eleventy-plugin-toc

v1.0.3

Published

Eleventy plugin for generating a table of contents from headings in your content, with many options for customisation.

Downloads

1,111

Readme

@uncenter/eleventy-plugin-toc

This repository is an updated fork of JordanShurmer/eleventy-plugin-nesting-toc with some additional features and bug fixes.

Easily generate a table of contents (toc) for your Eleventy site, with easy configuration and customization.

HTML:

<h1>Hello, World</h1>
Lorem ipsum dolor sit amet, consectetur adipisicing elit.

<h2 id="greetings-from-mars">Greetings from Mars</h2>
Lorem ipsum dolor sit amet, consectetur adipisicing elit.

<h3 id="the-red-planet">The red planet</h3>
Lorem ipsum dolor sit amet, consectetur adipisicing elit.

<h2 id="greetings-from-pluto">Greetings from Pluto</h2>

Generated TOC:

<nav class="toc">
	<ol>
		<li><a href="#greetings-from-mars">Greetings from Mars</a></li>
		<ol>
			<li><a href="#the-red-planet">The red planet</a></li>
		</ol>
		<li><a href="#greetings-from-pluto">Greetings from Pluto</a></li>
	</ol>
</nav>

Table of Contents

Install

npm i @uncenter/eleventy-plugin-toc
pnpm add @uncenter/eleventy-plugin-toc
yarn add @uncenter/eleventy-plugin-toc

Usage

Your heading tags will need to have ids on them, so that the TOC can provide proper anchor links to them. Eleventy does not do this for you out of the box. You can use a plugin like markdown-it-anchor to add those ids to the headings automatically (or a similar plugin for your Markdown engine of choice).

Note

Make sure not to duplicate the module.exports line in your config file for any of the examples below! If you already have a module.exports line, just add the lines above and below it to your config file.

// .eleventy.js / eleventy.config.js / eleventy.config.cjs

const markdownIt = require('markdown-it');
const markdownItAnchor = require('markdown-it-anchor');

module.exports = function (eleventyConfig) {
	eleventyConfig.setLibrary(
		'md',
		markdownIt({
			html: true,
			linkify: true,
			typographer: true,
		}).use(markdownItAnchor, {}),
	);
};

Then add the TOC plugin:

const pluginTOC = require('@uncenter/eleventy-plugin-toc');

module.exports = function (eleventyConfig) {
	eleventyConfig.addPlugin(pluginTOC);
};

Using the provided filter

<aside>
  {{ content | toc | safe }}
</aside>
<article>
  {{ content }}
</article>

Configuring

You can override some of the options at the time that you call it, or all of them when you add it in your Eleventy config. All of the options will be merged together, with the options passed to the filter taking precedence over the options passed to the plugin (which take precedence over the defaults).

Override the defaults for your whole site (defaults are shown):

{
    tags: ["h2", "h3", "h4"], // tags (heading levels) to include
    ignoredHeadings: ["[data-toc-exclude]"], // headings to ignore (list of selectors)
    ignoredElements: [], // elements (within the headings) to ignore when generating the TOC (list of selectors)
    ul: false, // whether to a use a `ul` or `ol`
    wrapper: function (toc) {
        // wrapper around the generated TOC
        return `<nav class="toc">${toc}</nav>`;
    },
}

Or override as it's being invoked:

<aside>
  {{ content | toc(tags=['h2', 'h3']) | safe }}
</aside>

If you have specific headings which you don't want to be included in the TOC, you can add one of the ignoredElements selectors to exclude these headings (defaults to the[data-toc-exclude] selector).

One way to add this attribute is via the use of the markdown-it-attrs plugin:

## Heading {data-toc-exclude}

Gotchyas

A few things must be in place for this to work properly, and provide the proper nested structure:

  • The first matched heading on the page should be the topmost. Don't put an <h3> before an <h2>!