Overview
md-editor-v3 is a Markdown editor for Vue3, developed in JSX and TypeScript. It provides a range of features including toolbar options, themes, shortcut keys, content beautification, multi-language support, picture uploading, direct article rendering, and customizable toolbars. The editor also supports extensions such as mermaid for diagrams and KaTeX for mathematical formulas.
Features
- Toolbar: Provides a toolbar with various options.
- Themes: Built-in default and dark themes for the editor.
- Shortcut key: Supports shortcut keys for the editor.
- Content beautification: Allows beautification of content using Prettier.
- Multi-language support: Built-in support for Chinese and English languages.
- Picture uploading: Enables pasting or uploading of pictures.
- Direct article rendering: Renders the article directly without the editor.
- Preview themes: Supports different preview themes such as vuepress, GitHub, cyanosis, and more.
Installation
To install md-editor-v3, you can use the following steps:
- Install the package using npm or yarn:
npm install md-editor-v3
- Import the necessary components in your Vue project:
import { MdEditor, MdPreview } from "md-editor-v3";
- Use the components in your template:
<MdEditor v-model="content" />
<MdPreview :modelValue="content" />
Summary
md-editor-v3 is a feature-rich Markdown editor for Vue3 that provides various options for editing and rendering Markdown content. It supports themes, shortcut keys, beautification of content, picture uploading, multi-language support, and more. The editor is easy to install and use in Vue projects.