rehype-slug

rehype plugin to add ids to headings.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(rehypeSlug[, options])
  • Options
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a unified (rehype) plugin to add ids to headings. It looks for headings (so <h1> through <h6>) that do not yet have ids and adds id attributes to them based on the text they contain. The algorithm that does this is github-slugger, which matches how GitHub works.

unified is a project that transforms content with abstract syntax trees (ASTs). rehype adds support for HTML to unified. hast is the HTML AST that rehype uses. This is a rehype plugin that adds ids to headings in the AST.

When should I use this?

This plugin is useful when you have relatively long documents and you want to be able to link to particular sections.

A different plugin, rehype-autolink-headings, adds links to these headings back to themselves, which is useful as it lets users more easily link to particular sections.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install rehype-slug

In Deno with esm.sh:

1import rehypeSlug from 'https://esm.sh/rehype-slug@6'

In browsers with esm.sh:

1<script type="module">
2  import rehypeSlug from 'https://esm.sh/rehype-slug@6?bundle'
3</script>

Use

Say we have the following file example.html:

1<h1 id=some-id>Lorem ipsum</h1>
2<h2>Dolor sit amet 😪</h2>
3<h3>consectetur &amp; adipisicing</h3>
4<h4>elit</h4>
5<h5>elit</h5>

…and our module example.js looks as follows:

1import {read} from 'to-vfile'
2import {rehype} from 'rehype'
3import rehypeSlug from 'rehype-slug'
4
5const file = await rehype()
6  .data('settings', {fragment: true})
7  .use(rehypeSlug)
8  .process(await read('example.html'))
9
10console.log(String(file))

…then running node example.js yields:

1<h1 id="some-id">Lorem ipsum</h1>
2<h2 id="dolor-sit-amet-">Dolor sit amet 😪</h2>
3<h3 id="consectetur--adipisicing">consectetur &#x26; adipisicing</h3>
4<h4 id="elit">elit</h4>
5<h5 id="elit-1">elit</h5>

API

This package exports no identifiers. The default export is rehypeSlug.

unified().use(rehypeSlug[, options])

Add ids to headings.

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

• prefix (string, default: '') — prefix to add in front of ids

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, rehype-slug@^6, compatible with Node.js 16.

This plugin works with rehype-parse version 1+, rehype-stringify version 1+, rehype version 1+, and unified version 4+.

Security

Use of rehype-slug can open you up to a cross-site scripting (XSS) attack as it sets id attributes on headings, which causes what is known as “DOM clobbering”. Please use rehype-sanitize and see its Example: headings (DOM clobbering) for information on how to properly solve it.

Related

• rehype-autolink-headings — add links to headings with IDs back to themselves

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer