editor.md/README.md

# Editor.md

![](https://pandao.github.io/editor.md/dist/images/logos/editormd-logo-180x180.png)

![](https://img.shields.io/github/stars/pandao/editor.md.svg)
![](https://img.shields.io/github/forks/pandao/editor.md.svg)
![](https://img.shields.io/github/tag/pandao/editor.md.svg)
![](https://img.shields.io/github/release/pandao/editor.md.svg)
![](https://img.shields.io/github/issues/pandao/editor.md.svg)
![](https://img.shields.io/bower/v/editor.md.svg)

**Editor.md** is an online(In-browser) markdown editor, based on CodeMirror & jQuery.

###Features

- Support Standard Markdown and GFM(GitHub Flavored Markdown);
- Full-featured: Real-time Preview, Image (cross-domain) upload, Multi-languages, L18n, Syntax highlighting...;
- Support ToC (Table of Contents);
- Compatible with all major browsers (IE8+), compatible Zepto.js and iPad;
- Support identification and interpretation of the HTML tags;
- Support TeX (LaTeX expressions, Based on KaTeX);
- Support Flowchart and Sequence Diagram of Markdown extended syntax;
- Support AMD/CMD (Require.js & Sea.js) Module Loader;


[README & Examples (English)](https://pandao.github.io/editor.md/en.html)

--------

**Editor.md** 是一个基于CodeMirror和jQuery构建的Markdown在线编辑器。

![editormd-screenshot](https://pandao.github.io/editor.md/examples/images/editormd-screenshot.png "editormd-screenshot")

####主要特性

- 支持Markdown标准和Github风格；
- 支持实时预览、图片（跨域）上传和多语言语法高亮；
- 兼容主流的浏览器（IE8+）和Zepto.js，且支持iPad等平板设备；
- 支持[ToC（Table of Contents）](https://pandao.github.io/editor.md/examples/toc.html)；
- 支持识别和解析HTML标签，具有几乎无限的扩展性；
- 支持TeX科学公式（基于[KaTeX](https://pandao.github.io/editor.md/examples/katex.html)）；
- 支持流程图 `flowchart` 和时序图 `sequenceDiagram`;
- 支持AMD/CMD模块化加载（支持 [Require.js](https://pandao.github.io/editor.md/examples/use-requirejs.html) & [Sea.js](https://pandao.github.io/editor.md/examples/use-seajs.html)）；

####在线演示

[https://pandao.github.io/editor.md/examples/index.html](https://pandao.github.io/editor.md/examples/index.html)

####下载和安装

通过Github下载安装，或者通过bower安装：

	bower install editor.md

####使用方法

HTML：

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

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

> 提示2：如果不想出现textarea闪现，则在textarea加上 style="display:none;"；

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](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](https://github.com/pandao/editor.md/tree/master/examples/use-seajs.html)

####依赖项目及感谢

- [CodeMirror](http://codemirror.net/ "CodeMirror")
- [marked](https://github.com/chjj/marked "marked")
- [jQuery](http://jquery.com/ "jQuery")
- [FontAwesome](http://fontawesome.io/ "FontAwesome")
- [github-markdown.css](https://github.com/sindresorhus/github-markdown-css "github-markdown.css")
- [KaTeX](http://khan.github.io/KaTeX/ "KaTeX")
- [prettify.js](http://code.google.com/p/google-code-prettify/ "prettify.js")
- [Rephael.js](http://raphaeljs.com/ "Rephael.js")
- [flowchart.js](http://adrai.github.io/flowchart.js/ "flowchart.js")
- [sequence-diagram.js](http://bramp.github.io/js-sequence-diagrams/ "sequence-diagram.js")

####更新日志

[查看更新日志](https://github.com/pandao/editor.md/blob/master/CHANGE.md)

####License

The MIT License.

Copyright (c) 2015 Pandao