Header anchors for markdown-it.
const md = require('markdown-it')
.use(require('markdown-it-anchor'), opts)See a demo as JSFiddle.
The opts object can contain:
| Name | Description | Default |
|---|---|---|
level |
Minimum level to apply anchors on. | 1 |
slugify |
A custom slugification function. | string.js' slugify |
permalink |
Whether to add permalinks next to titles. | false |
renderPermalink |
A custom permalink rendering function. | See index.es6.js |
permalinkClass |
The class of the permalink anchor. | header-anchor |
permalinkSymbol |
The symbol in the permalink anchor. | ¶ |
permalinkBefore |
Place the permalink before the title. | false |
permalinkHref |
A custom permalink href rendering function. |
See index.es6.js |
callback |
Called with token and info after rendering. | undefined |
The renderPermalink function takes the slug, an options object with
the above options, and then all the usual markdown-it rendering
arguments.
All headers above level will then have an id attribute with a slug
of their content, and if permalink is true, a ¶ symbol linking to
the header itself.
You may want to use the link symbol as
permalinkSymbol, or a symbol from your favorite web font.
The callback option is a function that will be called at the end of
rendering with the token and an info object. The info object has
title and slug properties with the token content and the slug used
for the identifier.