<h1 align="center">Markdown Editor built on Vue</h1>
 
<p align="center">
  <a href="https://npmcharts.com/compare/@kangc/v-md-editor?minimal=true"><img src="https://img.shields.io/npm/dm/@kangc/v-md-editor.svg?sanitize=true" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/@kangc/v-md-editor"><img src="https://img.shields.io/npm/v/@kangc/v-md-editor.svg?sanitize=true" alt="Version"></a>
  <a href="https://www.npmjs.com/package/@kangc/v-md-editor"><img src="https://img.shields.io/npm/l/@kangc/v-md-editor.svg?sanitize=true" alt="License"></a>
</p>
 
## Links
 
- [Demo](https://code-farmer-i.github.io/vue-markdown-editor/examples/base-editor.html)
- [Documentation](https://code-farmer-i.github.io/vue-markdown-editor/)
- [Changelog](https://code-farmer-i.github.io/vue-markdown-editor/changelog.html)
 
## Install
 
```bash
# use npm
npm i @kangc/v-md-editor -S
 
# use yarn
yarn add @kangc/v-md-editor
```
 
## Quick Start
 
```js
import Vue from 'vue';
import VueMarkdownEditor from '@kangc/v-md-editor';
import '@kangc/v-md-editor/lib/style/base-editor.css';
import vuepressTheme from '@kangc/v-md-editor/lib/theme/vuepress.js';
 
VueMarkdownEditor.use(vuepressTheme);
 
Vue.use(VueMarkdownEditor);
```
 
## Usage
 
```html
<template>
  <v-md-editor v-model="text" height="400px"></v-md-editor>
</template>
 
<script>
  export default {
    data() {
      return {
        text: '',
      };
    },
  };
</script>
```
 
## Refrence
 
- [ElementUi Scrollbar Component](https://github.com/ElemeFE/element/tree/dev/packages/scrollbar)
- [vuepress-plugin-container](https://vuepress.github.io/zh/plugins/container/)
 
## tip
vuepress 主题内置扩展了 tip 功能。同时你也可以在 left-toolbar 中使用 tip 来快捷插入。
 
效果如下：
::: tip 
  你可以点击 toolbar 中的 tip 来快速插入
:::
 
::: warning
  这是一段警告
:::
 
::: danger
这是一个危险警告
:::
 
::: details
  这是一个详情块，在 IE / Edge 中不生效
:::
 
::: tip 自定义标题
  你也可以自定义块中的标题
:::
 
::: danger STOP
  危险区域，禁止通行
:::