markdown/background_image

(require("markdown/background_image"))(md)

Marpit background image plugin.

Convert image token to backgrounds when the alternate text includes bg.

When Marpit inlineSVG option is false, the image will convert to backgroundImage and backgroundSize spot directive. It supports only single background and resizing by using CSS.

When inlineSVG option is true, the plugin enables advanced background mode. In addition to the basic background implementation, it supports multiple background images, filters, and split background.

Source:
Parameters:
Name Type Description
md MarkdownIt

markdown-it instance.