vuepress-plugin-md-enhance/README.md

Markdown enhancement plugin for vuepress

<!-- markdownlint-disable -->
<p align="center">
  <img width="240" src="https://plugin-md-enhance.vuejs.press/logo.svg" style="text-align: center;">
</p>
<h1 align="center">vuepress-plugin-md-enhance</h1>
<h4 align="center">Markdown enhancement plugin📄 / Markdown 增强插件📄</h4>

[![Author: Mr.Hope](https://img.shields.io/badge/Author-Mr.Hope-blue.svg?style=for-the-badge)](https://mister-hope.com)

<!-- markdownlint-restore -->

[![Version](https://img.shields.io/npm/v/vuepress-plugin-md-enhance.svg?style=flat-square&logo=npm)![Downloads](https://img.shields.io/npm/dm/vuepress-plugin-md-enhance.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/vuepress-plugin-md-enhance)

Markdown enhancement plugin📄 / Markdown 增强插件 📄

## [Official Docs](https://plugin-md-enhance.vuejs.press/) | [官方文档](https://plugin-md-enhance.vuejs.press/zh/)

## Install

```bash
# pnpm
pnpm add -D vuepress-plugin-md-enhance
# npm
npm i -D vuepress-plugin-md-enhance
# yarn
yarn add -D vuepress-plugin-md-enhance
```

## Migrating from V1

- drop flowchart support ![removed](https://img.shields.io/badge/-removed-red)

  We are adding mermaid support, and mermaid support flowchart.

- remove `imageFix` option ![removed](https://img.shields.io/badge/-removed-red)

  Links has been fixed in V2

- new option `hint` ![new](https://img.shields.io/badge/-new-brightgreen)

  Decides whether enable custom container that default theme provides

- option `delay` for the delay operating DOM when page loads or navigates ![new](https://img.shields.io/badge/-new-brightgreen)

- option `locale` to support i18n config ![new](https://img.shields.io/badge/-new-brightgreen)

- add SlidePage layout which can be used in themes ![new](https://img.shields.io/badge/-new-brightgreen)

- Auto load needed CDN for code demo ![new](https://img.shields.io/badge/-new-brightgreen)

---

## 安装

```bash
# pnpm
pnpm add -D vuepress-plugin-md-enhance
# npm
npm i -D vuepress-plugin-md-enhance
# yarn
yarn add -D vuepress-plugin-md-enhance
```

## 从 V1 迁移

- 移除 FlowChart 支持 ![移除](https://img.shields.io/badge/-移除-red)

  我们已经添加了 Mermaid 支持，而 Mermaid 支持流程图

- 移除 `imageFix` 选项 ![移除](https://img.shields.io/badge/-移除-red)

  图片链接已经在 V2 中得到修正

- 选项 `hint` ![新增](https://img.shields.io/badge/-新增-brightgreen)

  决定是否启用默认主题提供的自定义容器

- 选项 `delay`，控制页面加载和切换后进行 DOM 操作的延迟 ![新增](https://img.shields.io/badge/-新增-brightgreen)

- 选项 `locale` 以支持国际化配置 ![新增](https://img.shields.io/badge/-新增-brightgreen)

- 添加幻灯片布局，可在主题中引入使用 ![new](https://img.shields.io/badge/-new-brightgreen)

- 自动导入代码演示的所需 CDN ![new](https://img.shields.io/badge/-new-brightgreen)