unified

Project:rehypejs/rehype-slug

Package:rehype-slug@2.0.3

  1. Dependencies:5·Dependents:35
  2. rehype plugin to add id attributes to headings
  1. unified 132
  2. plugin 88
  3. rehype 76
  4. heading 24
  5. id 3
  6. slug 2

rehype-slug

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to add ids to headings.

Install

npm:

npm install rehype-slug

Use

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)

Add id properties to h1-h6 headings that don’t already have one.

Uses github-slugger to create GitHub style ids.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer