rehype-indexes

header index library for rehype

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

[npm][]:

npm install rehype-indexes

this library is intended to support react-markdown interactively. as named indexes, It supports heading tag to have suffix index number with anchor tag.

Use

following source code shows how to use with react-markdown.

import rehypIndex from 'rehype-indexes';

///... for index
<ReactMarkDown rehypePlugins={[[rehypeIndex, {mode: 'index'} ]]}>
{text}
</ReactMarkDown>

///... for origin document
<ReactMarkDown rehypePlugins={[[rehypeIndex, {mode: 'document'}]]}>
{text}
</ReactMarkDown>

Options

{mode: 'index'} or non-option.

• works for index.
• It remove all non-heading tags exclude tags inside heading tag. (! you don't need to remove non-heading tag by yourself.)
• It appends anchor tag 1 based.
• anchor tag has link to document heading id.

{mode: 'document'}

• works for document.
• It add id tag to heading.

Related

• unist-util-visit — Recursively walk over nodes
• react-markdown — Mainly targeted.

Contribute

All contributes are wellcome! 😀

License

[MIT][license] © Jeong Yo Han