@tlylt/markdown-it-imsize
v3.0.0
Published
Markdown-it plugin to specify image size
Downloads
164
Readme
@tlylt/markdown-it-imsize
(Patched to fix behaviors that are now inconsistent with the latest markdown-it)
A markdown-it plugin for size-specified image markups. This plugin overloads original image renderer of markdown-it.
Usage
Enable plugin
var md = require('markdown-it')({
html: true,
linkify: true,
typography: true
}).use(require('@tlylt/markdown-it-imsize')); // <-- this use(package_name) is required
Example
![test](image.png =100x200)
is interpreted as
<p><img src="image.png" alt="test" width="100" height="200"></p>
Options
Auto fill
var md = require('markdown-it')({
html: true,
linkify: true,
typography: true
}).use(require('@tlylt/markdown-it-imsize'), { autofill: true });
will fill the width and height fields automatically if the specified image path is valid.
Therefore,
![test](image.png)
is interpreted as
<p><img src="image.png" alt="test" width="200" height="200"></p>
where image.png
is a valid path and its size is 200 x 200.