markdown-image

Add additional features to your markdown images.

Usage

npm i -D @vuepress/plugin-markdown-image@next

import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'

export default {
  plugins: [
    markdownImagePlugin({
      // Enable figure
      figure: true,
      // Enable image lazyload
      lazyload: true,
      // Enable image mark
      mark: true,
      // Enable image size
      size: true,
    }),
  ],
}

Guide

Image Lazyload

The plugin will enable image lazyload using native HTML5 features, so it's only working on browsers which support loading=lazy attribute.

Image Mark

When you set mark: true in plugin options, you can mark pictures by #light and #dark suffix to let them be displayed under certain color mode.

![GitHub Light](/images/icon/github-light.svg#dark)
![GitHub Dark](/images/icon/github-dark.svg#light)

Advanced

You can pass an object to mark to config ID marks, available options are:

interface ImageMarkOptions {
  /** lightmode only IDs */
  light?: string[]
  /** darkmode only IDs */
  dark?: string[]
}

Image Size

When you set size: true in plugin options, you can append =widthxheight to image alt text with spaces as separator.

Both width and height should be numbers as pixels and are optional.

![Alt =200x300](/example.png)
![Alt =200x](/example.jpg 'Title')
![Alt =x300](/example.bmp)

Renders as ↓

<img src="/example.png" alt="Alt" width="200" height="300" />
<img src="/example.jpg" alt="Alt" title="Title" width="200" />
<img src="/example.bmp" alt="Alt" height="300" />

Obsidian Syntax

When you set obsidianSize: true in plugin options, you can append widthxheight after image alt text and use | to separate.

Both width and height should be numbers as pixels and are required. Setting one of them with 0 to scale by ratio with the other.

![Alt|200x200](/example.png)
![Alt|200x0](/example.jpg)
![Alt|0x300](/example.bmp)

Renders as ↓

<img src="/example.png" alt="Alt" width="200" height="300" />
<img src="/example.jpg" alt="Alt" width="200" />
<img src="/example.bmp" alt="Alt" height="300" />

Legacy Syntax (Deprecated)

When you set legacySize: true in plugin options, you can append =widthxheight at the end of image link section with spaces as separator.

Both width and height should be numbers as pixels and are optional.

![Alt](/example.png =200x300)
![Alt](/example.jpg "Title" =200x)
![Alt](/example.bmp =x300)

Renders as ↓

<img src="/example.png" width="200" height="300" />
<img src="/example.jpg" title="Title" width="200" />
<img src="/example.bmp" height="300" />

Figure Display

Sometimes, you may want to add a description with image and place it between contents, in this case you should set figure: true in plugin options.

If the 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>.

Demo

![VuePress Logo](/favicon.ico)

[![VuePress Logo](/favicon.ico)](https://vuejs.press/)

![VuePress Logo](/favicon.ico 'VuePress Logo')

[![VuePress Logo](/favicon.ico 'VuePress Logo')](https://vuejs.press/)

![VuePress Logo](https://vuejs.press/images/hero.png "VuePress Logo" =300x300)

Options

figure

• Type: MarkdownItFigureOptions | boolean
• Details: Whether enable figure support.

lazyload

• Type: boolean
• Details: Whether to lazy load every image in page in native way.

mark

• Type: MarkdownItImgMarkOptions | boolean

  interface MarkdownItImgMarkOptions {
    /** lightmode only IDs */
    light?: string[]
    /** darkmode only IDs */
    dark?: string[]
  }

• Details: Whether enable image mark support.

size

• Type: boolean
• Details: Whether enable image size support.

obsidianSize

• Type: boolean
• Details: Whether enable obsidian image size support.

legacySize

• Type: boolean
• Details: Whether enable legacy image size support.