farmingtong / web-editor-markdown Goto Github PK

基于 web 端的 Markdown 编辑器，支持协同编辑扩展和方便的插件扩展

web-editor-markdown 是一款基于 Web 浏览器，即时渲染的 Markdown 编辑器。它基于 TypeScript 和 JavaScript 打造，并且不依赖任何第三方框架，对中文支持友好，可以方便的进行扩展并接入到原生 JavaScript、Vue、React、Angular等应用中。它提供源码模式、双屏渲染模式、实时编辑模式和只读模式四种渲染模式。如果有需要，它的底层同时也支持了协同编辑的能力，提供了原子操作 Operation 用于扩展协同编辑。

web-editor-markdown is a Markdown editor based on Web browser and real-time rendering. It is based on TypeScript and JavaScript, and does not rely on any third-party framework. It supports Chinese friendly and can be easily extended and connected to native JavaScript, Vue, React, Angular and other applications. It provides four rendering modes: SOURCE, SOURCE_AND_PREVIEW, RENDER and PREVIEW. If necessary, its underlying layer also supports the ability of collaborative editing and provides atomic Operation for extending collaborative editing.

• 安装

npm install web-editor-markdown --save

• 使用

import { Editor, withUndoRedo } from "web-editor-markdown";
let editor = new Editor(document.getElementById('id')); // 初始化编辑器对象
editor = withUndoRedo(editor); // “撤销回退”插件生效
editor.insertTextAtCursor('**这是加粗文本**\n> 提示：通过 `cmd+/` 可以切换源码模式哦'); // 插入 markdown 内容

• 其他（更多 api 参考官网）

import { EditorViewMode } from "web-editor-markdown";
editor.switchViewMode(EditorViewMode.PREVIEW); // 切换模式：实时渲染、预览、源码、双屏模式，或者通过 cmd+/ 切换源码模式和实时渲染模式
console.log('content', editor.getContent()); // 获取编辑内容