node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

rehype-slug

rehype-slug Build Status Coverage Status

Add ids to headings with rehype.

Installation

npm:

npm install rehype-slug

Usage

Say we have the following file, fragment.html:

<h1>Lorem ipsum 😪</h1>
<h2>dolor—sit—amet</h2>
<h3>consectetur &amp; adipisicing</h3>
<h4>elit</h4>
<h5>elit</h5>

And our script, example.js, looks as follows:

var fs = require('fs');
var rehype = require('rehype');
var slug = require('rehype-slug');
 
rehype()
  .data('settings', {fragment: true})
  .use(slug)
  .process(fs.readFileSync('fragment.html'), function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

Now, running node example yields:

<h1 id="lorem-ipsum-">Lorem ipsum 😪</h1>
<h2 id="dolorsitamet">dolor—sit—amet</h2>
<h3 id="consectetur--adipisicing">consectetur &#x26; adipisicing</h3>
<h4 id="elit">elit</h4>
<h5 id="elit-1">elit</h5>

API

rehype().use(slug)

Adds id properties to h1-h6 headings which don’t already have one.

Uses github-slugger (thus creating GitHub style ids).

Related

License

MIT © Titus Wormer