Markdown Magic plugin to add local images to markdown.
npm install --save-dev markdown-magic-local-image
markdown.config.js
module.exports = {
transforms: {
LOCALIMAGE: require('markdown-magic-local-image'),
},
};
README.md
<!-- AUTO-GENERATED-CONTENT:START (LOCALIMAGE:heading=true&headingLevel=4&include=src/*.svg) -->
<!-- AUTO-GENERATED-CONTENT:END -->
Given a folder of svg's:
- src/add.svg
- src/close.svg
- src/home.svg
Yields:
README.md
<!-- AUTO-GENERATED-CONTENT:START (LOCALIMAGE:heading=true&headingLevel=4&include=src/*.svg) -->
#### add
![Alt text](src/add.svg "add")
#### close
![Alt text](src/close.svg "close")
#### home
![Alt text](src/home.svg "home")
<!-- AUTO-GENERATED-CONTENT:END -->
boolean
: defaults totrue
Add a heading, based on the filename, before each image.
number
: defaults to6
Control the heading level.
string
: defaults to'./**/*.{gif,jpg,png,svg}'
.
Glob pattern as supported by https://github.com/isaacs/node-glob.