README

Editor.md : The open source embeddable online markdown editor (component), based on CodeMirror & jQuery & Marked.

Features

• Support Standard Markdown / CommonMark and GFM (GitHub Flavored Markdown);
• Full-featured: Real-time Preview, Image (cross-domain) upload, Preformatted text/Code blocks/Tables insert, Code fold, Search replace, Read only, Themes, Multi-languages, L18n, HTML entities, Code syntax highlighting...;
• Markdown Extras : Support ToC (Table of Contents), Emoji, Task lists, @Links...;
• Compatible with all major browsers (IE8+), compatible Zepto.js and iPad;
• Support decode & fliter of the HTML tags & attributes;
• Support TeX (LaTeX expressions, Based on KaTeX), Flowchart and Sequence Diagram of Markdown extended syntax;
• Support AMD/CMD (Require.js & Sea.js) Module Loader, and Custom/define editor plugins;

README & Examples (English)

Editor.md 是一款开源的、可嵌入的 Markdown 在线编辑器（组件），基于 CodeMirror、jQuery 和 Marked 构建。

主要特性

• 支持通用 Markdown / CommonMark 和 GFM (GitHub Flavored Markdown) 风格的语法，也可变身为代码编辑器；
• 支持实时预览、图片（跨域）上传、预格式文本/代码/表格插入、代码折叠、跳转到行、搜索替换、只读模式、自定义样式主题和多语言语法高亮等功能；
• 支持 ToC（Table of Contents）、Emoji表情、Task lists、@链接等 Markdown 扩展语法；
• 支持 TeX 科学公式（基于 KaTeX）、流程图 Flowchart 和 时序图 Sequence Diagram;
• 支持识别和解析 HTML 标签，并且支持自定义过滤标签及属性解析，具有可靠的安全性和几乎无限的扩展性；
• 支持 AMD / CMD 模块化加载（支持 Require.js & Sea.js），并且支持自定义扩展插件；
• 兼容主流的浏览器（IE8+）和 Zepto.js，且支持 iPad 等平板设备；

Examples

https://pandao.github.io/editor.md/examples/index.html

Download & install

Github download

Bower install :

bower install editor.md

Usages

HTML：

<link rel="stylesheet" href="editormd.min.css" /> <div id="editormd"> <textarea style="display:none;">### Hello Editor.md !</textarea> </div>

Tip: Editor.md can auto append <textarea> tag;

javascript:

<script src="jquery.min.js"></script> <script src="editormd.min.js"></script> <script type="text/javascript"> $(function() { var editor = editormd("editormd", { path : "../lib/" // Autoload modules mode, codemirror, marked... dependents libs path }); /*  // or  var editor = editormd({  id : "editormd",  path : "../lib/"  });  */ }); </script>

Using modular script loader :

• Using Require.js
• Using Sea.js

Dependents

• CodeMirror
• marked
• jQuery
• FontAwesome
• github-markdown.css
• KaTeX
• prettify.js
• Rephael.js
• flowchart.js
• sequence-diagram.js
• Prefixes.scss

Changes

Change logs

License

The MIT License.

Copyright (c) 2015 Pandao