unified

Project: iloveip/remark-heading-autoid

Package: remark-heading-autoid@0.1.1

  1. Remark plugin to support headings auto ids
  1. 37%
  2. MIT
  3. 0
  1. 1.03 kB
  2. 6
  1. remark 213
  2. heading 26
  3. id 4
  4. auto 3

remark-heading-autoid

remark plugin to add numbered auto ids to headings:

<h2 id="id1">head</h2>

The plugin also supports custom ids:

## My Heading {#custom-id}

Will output to:

<h2 id="custom-id">My Heading</h2>

Install

npm install remark-heading-autoid

Options

You can pass a custom prefix for ids in options. If no prefix is provided, id, followed by the consecutive number of the heading, is used.

Use with Gatsby and MDX

In gatsby-congis.js:

const autoHeading = require('remark-heading-autoid')
module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-mdx`,
      options: {
        remarkPlugins: [autoHeading, otherPlugin]
      }
    }
  ]
}

Use with options:

const autoHeading = require('remark-heading-autoid')
module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-mdx`,
      options: {
        remarkPlugins: [[autoHeading, { prefix: 'heading-'}], otherPlugin]
      }
    }
  ]
}