markdown-it-figure-references
v2.1.0-alpha.3
MarkdownIt Plugin for image references and list
0/weekUpdated 3 years agoGPL-3.0Unpacked: 53.3 KB
Published by Alija Sabic
npm install markdown-it-figure-referencesmarkdown-it-figure-references
> Figure referencing for markdown-it.
Installation
``sh`
yarn add markdown-it-figure-references
or
`sh`
npm install markdown-it-figure-references
Example
`mdHello World
`html`Hello World
§
Figure 1: The Stormtroopocat
List of Figures
Plain HTML figures and images are supported too.
`mdHello World
`
`html`Hello World
§Figure 1: The
Stormtroopocat
List of Figures
Usage
`js`
const md = require("markdown-it")().use(require("markdown-it-figure-references"), opts);
See a demo as JSFiddle.
The opts object can contain:
| Name | Description | Default |
| -------- | ----------------------------------------------- | ----------- |
| after | Rule name to insert new rules after. | false |ns
| | Namespace for saving registered images (env). | "figures" |wrap
| | Wrap in a element. | true |anchor
| | Anchor options. | see below |label
| | Label options. | see below |list
| | List options. | see below |
The anchor object can contain:
| Name | Description | Default |
| --------- | ---------------------------------- | ---------- |
| enable | Insert anchor before figure label. | true |content
| | Anchor content. | "§" |class
| | Anchor class. | "anchor" |
The label object can contain:
| Name | Description | Default |
| ------------- | ------------------------------------------ | ------------ |
| enable | Insert figure label before figure caption. | true |text
| | Figure label text. | "Figure #" |placeholder
| | Figure number placeholder. | "#" |class
| | Figure label class. | "label" |
The list object can contain:
| Name | Description | Default |
| -------- | ----------------------- | ------------------- |
| enable | Append list of figures. | true |class
| | List of figures class. | "list" |title
| | List title. | "List of Figures" |tag
| | HTML tag for list. | "ol" |item
| | List item options | see below |
The item object can contain:
| Name | Description | Default |
| ------- | --------------------------------- | -------- |
| tag | HTML tag for list item. | "li" |href
| | Add target id to list item label. | true |class
| | List item class. | "item" |label
| | Insert figure label. | true |title
| | Insert figure title. | true` |