@mdit/plugin-figure
Plugin for generating figures with captions from images.
Usage
TS
import MarkdownIt from "markdown-it";
import { figure } from "@mdit/plugin-figure";
const mdIt = MarkdownIt().use(figure, {
// your options, optional
});
mdIt.render("");
JS
const MarkdownIt = require("markdown-it");
const { figure } = require("@mdit/plugin-figure");
const mdIt = MarkdownIt().use(figure, {
// your options, optional
});
mdIt.render("");
Syntax
Sometimes, you may want to add a description with image and place it between contents, so here is this plugin.
If a image is standalone in a line, wrapped or not wrapped by link, it will be displayed as <figure> and title (or alt) will be displayed as <figcaption>.
Options
interface MarkdownItFigureOptions {
/**
* Whether the figure is focusable
*
* @default true
*/
focusable?: boolean;
}