85 lines
3.0 KiB
Markdown
85 lines
3.0 KiB
Markdown
<!-- 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)
|