1 Star 0 Fork 31

杨杨洒洒 / web-editor-markdown

forked from 曾勇 / web-editor-markdown 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

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

npm bundle size

💡 Web Editor Markdown

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

web-editor-markdown is a Markdown editor based on Web browser and real-time rendering like Typora. 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.

✨ 中文演示

✨ Demo

🛠️ 使用说明

  • 安装
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()); // 获取编辑内容
MIT License Copyright (c) 2022 Ben-love-zy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

基于 web 端的 Markdown 编辑器,支持协同编辑扩展和方便的插件扩展 展开 收起
TypeScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/netsun_admin/web-editor-markdown.git
git@gitee.com:netsun_admin/web-editor-markdown.git
netsun_admin
web-editor-markdown
web-editor-markdown
master

搜索帮助