![license](https://badgen.net/github/license/mdit-vue/mdit-vue)
A markdown-it plugin to get markdown headers.
- Extracts all headers info into markdown-it
env.headers
.
Install
npm i @mdit-vue/plugin-headers
Usage
import MarkdownIt from 'markdown-it';
import { headersPlugin } from '@mdit-vue/plugin-headers';
import type { MarkdownItEnv } from '@mdit-vue/types';
const md = MarkdownIt({ html: true }).use(headersPlugin, {
});
const env: MarkdownItEnv = {};
const rendered = md.render(
`\
# h1
## h2
### h3
`,
env,
);
console.log(env.headers);
Options
format
level
-
Type: number[]
-
Default: [2, 3]
-
Details:
Heading level that going to be extracted.
When using this plugin with markdown-it-anchor (recommended), this option should be a subset of markdown-it-anchor's level
option to ensure the header slugs are existed.
slugify
-
Type: (str: string) => string
-
Default: slugify
from @mdit-vue/shared
-
Details:
A custom slugification function.
The default slugify function comes from @mdit-vue/shared package.
When using this plugin with markdown-it-anchor (recommended), this option will be ignored because the id
of the headings have already been determined by markdown-it-anchor's slugify
option.