0.0.20 • Published 4 years ago

rehype-indexes v0.0.20

Weekly downloads
-
License
-
Repository
github
Last release
4 years ago

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

Contribute

All contributes are wellcome! 😀

License

MIT © Jeong Yo Han

0.0.20

4 years ago

0.0.19

4 years ago

0.0.18

4 years ago

0.0.17

4 years ago

0.0.16

4 years ago

0.0.15

4 years ago

0.0.14

4 years ago

0.0.13

4 years ago

0.0.12

4 years ago

0.0.11

4 years ago

0.0.10

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago