https://github.com/code-farmer-i/vue-markdown-editor

A markdown editor built on Vue
https://github.com/code-farmer-i/vue-markdown-editor

editor markdown vue vue3

Last synced: 6 days ago
JSON representation

A markdown editor built on Vue

• Host: GitHub
• URL: https://github.com/code-farmer-i/vue-markdown-editor
• Owner: code-farmer-i
• License: mit
• Created: 2020-04-04T11:10:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T09:22:32.000Z (about 2 months ago)
• Last Synced: 2024-12-11T15:06:21.781Z (13 days ago)
• Topics: editor, markdown, vue, vue3
• Language: JavaScript
• Homepage: https://code-farmer-i.github.io/vue-markdown-editor/
• Size: 21.6 MB
• Stars: 1,103
• Watchers: 4
• Forks: 109
• Open Issues: 121
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
Markdown Editor built on Vue3




  

  

  



## 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/)

- [中文文档](https://code-farmer-i.github.io/vue-markdown-editor/zh/)

- [国内文档镜像](http://ckang_1229.gitee.io/vue-markdown-editor/zh/)

- [Changelog](https://code-farmer-i.github.io/vue-markdown-editor/changelog.html)

## Communication

qq group: 798884474

## Install

```bash

# use npm

npm i @kangc/v-md-editor@next -S

# use yarn

yarn add @kangc/v-md-editor@next

```

## Quick Start

```js

import { createApp } from 'vue';

import App from 'App.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';

import '@kangc/v-md-editor/lib/theme/style/vuepress.css';

VueMarkdownEditor.use(vuepressTheme);

createApp(App).use(VueMarkdownEditor);

```

## Usage

```html

  import { ref } from 'vue';

  const text = ref('');

  

```

## Refrence

- [ElementUi Utils clickoutside](https://github.com/ElemeFE/element/blob/dev/src/utils/clickoutside.js)

- [ElementUi Utils resize-event](https://github.com/ElemeFE/element/blob/dev/src/utils/resize-event.js)

- [ElementUi Utils scrollbar-width](https://github.com/ElemeFE/element/blob/dev/src/utils/scrollbar-width.js)

- [ElementUi Scrollbar Component](https://github.com/ElemeFE/element/tree/dev/packages/scrollbar)

- [vuepress-plugin-container](https://github.com/vuepress/vuepress-community/blob/master/packages/vuepress-plugin-container/src/markdown-it-container.ts)

- [vuepress markdown preWrapper](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown/lib/preWrapper.js)

- [vuepress markdown link](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown/lib/link.js)

- [markdown-it-katex](https://github.com/waylonflinn/markdown-it-katex/blob/master/index.js)

- [markdown-it-table-of-contents](https://github.com/Oktavilla/markdown-it-table-of-contents/blob/master/index.js)

- [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists/blob/master/index.js)

## License

[MIT](https://github.com/code-farmer-i/vue-markdown-editor/blob/dev/LICENSE)