rehype-slugify

rehype plugin to add ids to headings with a custom slugify function.

Installation

npm install rehype-slugify

Usage

Given the html:

1<h1>HELLO</h1>
2<p>world!</p>

And our js script:

1import fs from 'node:fs'
2import {rehype} from 'rehype'
3import slugify from 'rehype-slug'
4
5const buf = fs.readFileSync('fragment.html')
6
7rehype()
8  .data('settings', {fragment: true})
9  .use(slugify, {slugify: (content) => {
10    return content.toLowerCase();
11  }})
12  .process(buf)
13  .then((file) => {
14    console.log(String(file))
15  })

It will print out:

1<h1 id="hello">HELLO</h1>
2<p>world!</p>

API

Default export is rehypeSlugify. It requires the a slugify function in options, and throws an error if not provided.