imcuttle / remark-heading-id

The remark plugin for supporting custom heading id

remark-heading-id

The remark plugin for supporting custom heading id and Default Id

Custom Heading Input

### My Great Heading {#custom-id}

Custom Heading Output

<h3 id="custom-id">My Great Heading</h3>

API

This package exports no identifiers. The default export is remarkHeaderId.

unified().use(remarkHeadingId[, options])

options

Configuration (optional).

options.defaults

Whether to add default ids based on the title text (boolean, default: false).

options.uniqueDefaults

Whether to ensure that the default ids created by options.defaults are unique (boolean, default: true). Only relevant when options.defaults = true. Example:

## heading

### introduction

### argument

## heading

### introduction

### argument

Will generate this output when options.defaults = true and options.uniqueDefaults = true:

<h2 id="heading">heading</h2>
<h3 id="indroduction">indroduction</h3>
<h3 id="argument">argument</h3>
<h2 id="heading-1">heading</h2>
<h3 id="introduction-1">introduction</h3>
<h3 id="argument-1">argument</h3>

Instead of this output, which is generated when options.defaults = true and options.uniqueDefaults = false:

<h2 id="heading">heading</h2>
<h3 id="indroduction">indroduction</h3>
<h3 id="argument">argument</h3>
<h2 id="heading">heading</h2>
<h3 id="introduction">introduction</h3>
<h3 id="argument">argument</h3>

The difference being that the last output contains duplicate ids in the generated html, which are avoided using options.uniqueDefaults = true.

Default Heading Input

### My Great Heading

Default Heading Output

<h3 id="my-great-heading">My Great Heading</h3>

Contributing

• Fork it!
• Create your new branch:
  git checkout -b feature-new or git checkout -b fix-which-bug
• Start your magic work now
• Make sure npm test passes
• Commit your changes:
  git commit -am 'feat: some description (close #123)' or git commit -am 'fix: some description (fix #123)'
• Push to the branch: git push
• Submit a pull request :)

Authors

This library is written and maintained by imcuttle, [email protected].

License

MIT - imcuttle 🐟

remark-heading-id's Issues

Add @types/remark-heading-id

Support TypeScript by adding @types/remark-heading-id.

Is this package still maintained?

Hi. Thanks for your work on this package! I was researching incorporating this plugin into my remark toolchain when I came across remark-custom-heading-id, which seems to fix some issues with this package and MDX compatibility, as well as updating deps to work with the latest versions of remark, though it lacks a default export. Is remark-heading-id still maintained? The example in README.md doesn't seem to work.

remark@next (13)

Hi!

remark is switching to a new parser internally (micromark, see remarkjs/remark#536 for more info).
From a quick glance at the code, it seems this plugin should be fine. However, it would be good to check that in the future (there is 13.0.0-alpha.0 published now, and one or two more will come before the release)

Pollutes by prepending `user-content-` to ids

It doesn't seem this lib is doing it. But I don't find how to disable it in remark.

I know it's for security measures when the content is coming from users, but my content is coming from me so I have no intention to abuse ids and have simple and pure ids, and I'd like to disable this prefix.

Any way to disable it?