README

Editor.md : 基于 CodeMirror、jQuery 和 Marked 的开源、可嵌入的在线 Markdown 编辑器（组件）。

功能特性

• 支持标准 Markdown / CommonMark 和 GFM (GitHub Flavored Markdown)；
• 全功能：实时预览、图片（跨域）上传、预格式文本/代码/表格插入、代码折叠、搜索替换、只读模式、主题、多语言、L18n、HTML 实体、代码语法高亮...；
• Markdown 扩展：支持 ToC（目录）、Emoji 表情、任务列表、@链接...；
• 兼容所有主流浏览器（IE8+）、兼容 Zepto.js 和 iPad；
• 支持 解码和过滤 HTML 标签及属性；
• 支持 Markdown 扩展语法的 TeX 科学公式（基于 KaTeX）、流程图 Flowchart 和 时序图 Sequence Diagram；
• 支持 AMD/CMD 模块化加载（支持 Require.js & Sea.js），并支持自定义扩展插件；

README & 示例（英文）

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

主要特性

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

示例

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

下载 & 安装

Github 下载

Bower 安装

bower install editor.md

使用方法

HTML：

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

提示：Editor.md 可以自动添加 <textarea> 标签；

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>

使用模块化脚本加载器

• 使用 Require.js
• 使用 Sea.js

依赖项

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

变更

变更日志

许可

MIT 许可协议。

版权所有（c）2015 Pandao