前端实现Markdown编辑器(EpicEditor)

EpicEditor是可嵌入的JavaScript Markdown编辑器,具有全屏拆分编辑,实时预览,自动草稿保存,脱机支持等功能。对于开发人员来说,它提供了一个健壮的API,可以轻松地进行主题化,并允许您将捆绑的Markdown解析器与您扔给它的任何东西交换出去。

官方网站:http://epiceditor.com
GitHub:https://github.com/OscarGodson/EpicEditor
EpicEditor使用起来非常简单,调用只需要一行代码:

var editor = new EpicEditor().load();

具体步骤如下:

1、 下载

从github上下载最新的版本

$ git clone git@github.com:OscarGodson/EpicEditor

目录结构如下:


目录结构

其中index.html就是其官方网站的主页面,我们可以打开这个页面查看EpicEditor的各种文档。

2、 安装

将epiceditor目录拷贝到你的web工程中,例如拷贝到/static/lib/epiceditor。

$ scp -r EpicEditor/epiceditor you@webserver:public_html/static/lib/

3、 创建容器元素

<div id="epiceditor"></div>

当然也可以打包当前存在的textarea当做容器用来载入EpicEditor。

<div id="epiceditor"><textarea id="my-edit-area"></textarea></div>

4、 添加epiceditor.js文件

<script src="/static/lib/epiceditor/js/epiceditor.min.js"></script>

5、 初始化EpicEditor

EpicEditor需要知道在哪里可以找到其主题,因此需要在初始化时告知它的安装目录。

var editor = new EpicEditor({basePath: '/static/lib/epiceditor'}).load();

最简单的页面源码:

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <title></title>
    </head>
    <body>
        <script src="epiceditor/js/epiceditor.min.js"></script>
        <div id="epiceditor"></div>
        <script>
            var editor = new EpicEditor({basePath: 'epiceditor'}).load();
        </script>
    </body>
</html>
全屏效果

6、 选项

在上面的初始化例子中,只给出了basePath选项,而EpicEditor还提供了很多其他的丰富选项用来修改EpicEditor的主题。

选项 描述 默认
container 您希望编辑器出现在其中的目标容器的ID(字符串)或元素(对象)。 epiceditor
textarea 您要与之同步编辑器内容的文本区域的ID(字符串)或元素(对象)。在页面加载时,如果文本区域中有内容,编辑器将使用该内容作为其内容 null
basePath 包含的目录的基本路径/themes epiceditor
clientSideStorage 将此设置为false将禁用localStorage true
localStorageName 用于localStorage对象的名称 epiceditor
useNativeFullscreen 设置为false始终使用仿全屏显示(与不支持的浏览器使用的相同) true
parser 已标记是EpicEditor内置的唯一解析器,但是您可以通过将解析函数传递给此选项来自定义或切换此解析器。例如: parser: MyCustomParser.parse marked
focusOnLoad 如果为true,则编辑器将专注于加载 false
file.name 如果不存在使用该名称的文件,则将创建一个新文件,否则将打开现有文件 容器编号
file.defaultContent 要显示的内容,如果文件不存在任何内容。注意:如果使用此textarea选项,则textarea的值将优先于defaultContent
file.autoSave 自动保存文件的频率(以毫秒为单位)。设置为false关闭。 100
theme.base 基本样式,例如带有按钮的工具栏 themes/base/epiceditor.css
theme.editor 编辑器的主题是您键入的区域 themes/editor/epic-dark.css
theme.preview 预览器的主题 themes/preview/github.css
button 如果设置为,false将删除所有按钮 所有按钮均设置为true
button.preview 如果设置为,false将删除预览按钮 true
button.fullscreen 如果设置为,false将删除全屏按钮 true
button.bar 如果true或"show",任何定义的按钮将始终可见。如果false或"hide",任何定义的按钮将永远不可见。如果为"auto",则通常将隐藏按钮,但是只要移动鼠标便会显示 "auto"
shortcut.modifier 按住其他快捷键以触发组合键时按住的键 18(alt键)
shortcut.fullscreen 打开全屏的快捷方式 70(f键)
shortcut.preview 切换预览器的快捷方式 80(p键)
string.togglePreview 悬停在预览图标上时出现的工具提示文本 Toggle Preview Mode
string.toggleEdit 悬停在编辑图标上时出现的工具提示文本 Toggle Edit Mode
string.toggleFullscreen 悬停全屏图标时显示的工具提示文本 Enter Fullscreen
autogrow 是否自动增长EpicEditor以适合其内容。如果需要自动增长,则可以指定true,表示使用默认的自动增长设置,也可以指定一个对象来定义自定义设置 false
autogrow.minHeight 编辑器应缩小到的最小高度(以像素为单位)。如果这不是常数,也可以采用返回期望的minHeight的函数;如果不希望最小值,则返回false值 80
autogrow.maxHeight 编辑器应增长到的最大高度(以像素为单位)。如果这不是常数,也可以采用返回期望的maxHeight的函数;如果不需要最大值,则返回假值 false
autogrow.scroll 自动增长时是否应滚动页面以将插入符号保持在相同的垂直位置(特别推荐用于移动设备) true

样例:

var opts = {
  container: 'epiceditor',
  textarea: null,
  basePath: 'epiceditor',
  clientSideStorage: true,
  localStorageName: 'epiceditor',
  useNativeFullscreen: true,
  parser: marked,
  file: {
    name: 'epiceditor',
    defaultContent: '',
    autoSave: 100
  },
  theme: {
    base: '/themes/base/epiceditor.css',
    preview: '/themes/preview/preview-dark.css',
    editor: '/themes/editor/epic-dark.css'
  },
  button: {
    preview: true,
    fullscreen: true,
    bar: "auto"
  },
  focusOnLoad: false,
  shortcut: {
    modifier: 18,
    fullscreen: 70,
    preview: 80
  },
  string: {
    togglePreview: 'Toggle Preview Mode',
    toggleEdit: 'Toggle Edit Mode',
    toggleFullscreen: 'Enter Fullscreen'
  },
  autogrow: false
}
var editor = new EpicEditor(opts) .load();
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342