dotpub / editor.md

A simple online markdown editor.

Editor.md

Editor.md is an online markdown editor, based on CodeMirror & jQuery & Marked.

###Features

• Support Standard Markdown 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 identification, interpretation, fliter of the HTML tags;
• 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 是一个基于CodeMirror、jQuery 和 Marked 构建的 Markdown 在线编辑器。

####主要特性

• 支持“标准”Markdown和Github风格的语法，也可变身为代码编辑器；
• 支持实时预览、图片（跨域）上传、预格式文本/代码/表格插入、代码折叠、搜索替换、只读模式、自定义样式主题和多语言语法高亮等功能；
• 支持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下载安装，或者通过 Bower 安装：

bower install editor.md

####使用方法 (Usage)

HTML：

<link rel="stylesheet" href="../dist/css/editormd.css" />
<div id="test-editormd">
    <textarea style="display:none;">###Hello world!</textarea>
</div>

提示1：如果没有Markdown源内容或者通过Ajax异步加载Markdown源文档等，可以不添加<textarea>，会自动添加；

javascript:

<script src="../lib/jquery.min.js"></script>
<script src="../src/js/editormd.js"></script>
<script type="text/javascript">
    $(function() {
        var testEditor = editormd("test-editormd", {
            path : '../lib/' // codemirror、marked等依赖的库的路径
        });
    });
</script>

Require.js的使用方法：https://github.com/pandao/editor.md/tree/master/examples/use-requirejs.html

Sea.js的使用方法：https://github.com/pandao/editor.md/tree/master/examples/use-seajs.html

####依赖项目及感谢 (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