💠 markdown-it-inline-svg

A markdown-it plugin which inlines svg files when referenced as an image source.

📦 Installation

[!Note]

This library is distributed only as an ESM module.

npm install @saeris/markdown-it-inline-svg

or

yarn add @saeris/markdown-it-inline-svg

🔧 Usage

import markdownIt from "markdown-it";
import inlineSVGPlugin from "@saeris/markdown-it-inline-svg";

const result = markdownIt()
    .use(inlineSVGPlugin)
    .render('![](./path/to/image.svg)', {
        // this environment variable is required to determine
        // relative import paths
        currentDocument: import.meta.url
    });

console.log(result)
// => "<p><svg width="..." height="..." viewBox="..."><!-- ... --></svg></p>"

🥂 License

Released under the MIT © Drake Costa