10 Star 143 Fork 31

曾勇 / web-editor-markdown

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

web-editor-markdown
A markdown editor in browser, supports collaborative editing

npm bundle size

💡 Web Editor Markdown

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.

✨ English Demo

✨ Chinese Demo

🛠️ Getting started

  • install it
npm install web-editor-markdown --save
  • use it
import { Editor, withUndoRedo } from "web-editor-markdown";
let editor = new Editor(document.getElementById('id'));
editor = withUndoRedo(editor); // UndoRedo Plugin
editor.insertTextAtCursor('**This is a bold text**\n> tips:You can switch source mode with `cmd+/`');
  • others
import { EditorViewMode } from "web-editor-markdown";
editor.switchViewMode(EditorViewMode.PREVIEW); // switch rendering mode,(shortcut key: 'cmd+/')
console.log('content', editor.getContent());
  • local source
npm install
npm start
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 等 3 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助