Skip to content
Add slugs to headings in remark
Branch: master
Clone or download
Latest commit c6c14f3 Nov 22, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig Refactor code-style to use `xo` Aug 24, 2016
.gitignore Add `yarn.lock` to `.gitignore` Aug 13, 2018
.npmrc Add `.npmrc` Aug 13, 2018
.prettierignore Add `.prettierignore` Aug 13, 2018
index.js Add support for using existing ids Aug 13, 2018
package.json 5.1.1 Nov 22, 2018
test.js Fix tests Aug 13, 2018


Build Coverage Downloads Chat Sponsors Backers

Add anchors to remark heading nodes using GitHub’s algorithm.

⚠️ This is often useful when compiling to HTML. If you’re doing that, it’s probably smarter to use remark-rehype and rehype-slug and benefit from the rehype ecosystem.



npm install remark-slug


Say we have the following file,

# Lorem ipsum 😪

## dolor—sit—amet

### consectetur & adipisicing

#### elit

##### elit

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

var fs = require('fs')
var unified = require('unified')
var markdown = require('remark-parse')
var slug = require('remark-slug')
var remark2rehype = require('remark-rehype')
var html = require('rehype-stringify')

  .process(fs.readFileSync(''), function(err, file) {
    if (err) throw err

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>



Adds slugs to markdown headings.

Uses github-slugger, which creates GitHub-style slugs.

Sets and on heading nodes. The first can be used by any plugin as a unique identifier, the second tells mdast-util-to-hast (used in remark-html and remark-rehype) to use its value as an id attribute.



See in remarkjs/remark for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.


MIT © Titus Wormer

You can’t perform that action at this time.