Package Exports
- markdown-it-anchor
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown-it-anchor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
markdown-it-anchor 
Header anchors for markdown-it.
Usage
const md = require('markdown-it')
.use(require('markdown-it-anchor'), opts)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 |
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.