vue-markdown/docs/README.md

28 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

# 介绍
vue-marodown是一款使用marked和highlight.js开发的一款markdown编辑器主要包括三个部分
1. 简单版编辑器左侧文本输入框使用textarea实现
2. 专业版编辑器左侧输入框使用codemirror实现
3. markdown预览组件可单独使用。
## 简单版编辑器
简单版编辑器为默认编辑器,具有体积小的优势,功能上相对于专业版无删减,区别在于
- 不支持输入文本识别,无法根据不同的语法在输入框内显示不同的样式
- 头部菜单插入内容时不支持对已选择文本区域操作
## 专业版编辑器
左侧的编辑区域使用codemirror实现看起来更像一个专业的编辑器保留了编辑器绝大多数功能相比于普通版区别为
- 支持根据输入的文本类型显示不同样式
- 支持设置代码块语言,并高亮显示
- 支持对输入框内的文本选中后进行操作
## 预览组件
预览组件为单独的一个组件区别于编辑器内的预览模式显示样式与编辑器内预览区域完全一致支持设置主题复制代码预览图片、设置maked.js初始化设置等功能。
## 如何选用
- 如果支持想简单的实现一个富文本编辑器对功能和输入框样式没有过多的要求建议简单版即可毕竟体积优势大gzip压缩后仅有50kb。
- 如果想让编辑器看起来更专业一点儿文本输入区域功能更强大一点儿建议选用pro版代价是文件体积将会变大。
- 如果只是想单纯的展示markdown文件选用markdown-preview即可。