-
Notifications
You must be signed in to change notification settings - Fork 334
/
index.html
595 lines (583 loc) · 31.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
<!DOCTYPE html>
<html>
<head>
<title>EpicEditor - An embeddable JavaScript Markdown editor</title>
<meta name="description" content="EpicEditor is an embeddable JavaScript Markdown editor with split fullscreen editing, live previewing, automatic draft saving, offline support, and more.">
<link href='http://fonts.googleapis.com/css?family=Lato:400,400italic|Arvo:400,400italic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="docs/css/main.css">
<link rel="stylesheet" href="docs/css/prettify.css">
<link rel="shortcut icon" href="docs/favicon.ico">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-4491651-6']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="wrapper">
<h1 id="-epiceditor-http-epiceditor-com-docs-images-epiceditor-logo-png-"><img src="http://epiceditor.com/docs/images/epiceditor-logo.png" alt="EpicEditor"></h1>
<h2 id="an-embeddable-javascript-markdown-editor">An Embeddable JavaScript Markdown Editor</h2>
<p>EpicEditor is an embeddable JavaScript <a href="http://daringfireball.net/projects/markdown/">Markdown</a> editor with split fullscreen editing, live previewing, automatic draft saving, offline support, and more. For developers, it offers a robust API, can be easily themed, and allows you to swap out the bundled Markdown parser with anything you throw at it.</p>
<h2 id="why">Why</h2>
<p>Because, WYSIWYGs suck. Markdown is quickly becoming the replacement. <a href="http://github.com">GitHub</a>, <a href="http://stackoverflow.com">Stackoverflow</a>, and even blogging apps like <a href="http://posterous.com">Posterous</a> are now supporting Markdown. EpicEditor allows you to create a Markdown editor with a single line of JavaScript:</p>
<pre><code class="lang-javascript">var editor = new EpicEditor().load();
</code></pre>
<h2 id="quick-start">Quick Start</h2>
<p>EpicEditor is easy to implement. Add the script and assets to your page, provide a target container and call <code>load()</code>.</p>
<h3 id="step-1-download">Step 1: Download</h3>
<p><a href="http://epiceditor.com">Download the latest release</a> or clone the repo:</p>
<pre><code class="lang-bash">$ git clone [email protected]:OscarGodson/EpicEditor
</code></pre>
<h3 id="step-2-install">Step 2: Install</h3>
<p>Copy <code>EpicEditor/epiceditor/</code> onto your webserver, for example to <code>/static/lib/epiceditor</code>.</p>
<pre><code class="lang-bash">$ scp -r EpicEditor/epiceditor you@webserver:public_html/static/lib/
</code></pre>
<p>You can of course customize this step for your directory layout.</p>
<h3 id="step-3-create-your-container-element">Step 3: Create your container element</h3>
<pre><code class="lang-html"><div id="epiceditor"></div>
</code></pre>
<p>Alternately, wrap an existing textarea to load the contents into the EpicEditor instance.</p>
<pre><code class="lang-html"><div id="epiceditor"><textarea id="my-edit-area"></textarea></div>
</code></pre>
<h3 id="step-4-add-the-epiceditor-js-file">Step 4: Add the <code>epiceditor.js</code> file</h3>
<pre><code class="lang-html"><script src="/static/lib/epiceditor/js/epiceditor.min.js"></script>
</code></pre>
<h3 id="step-5-init-epiceditor">Step 5: Init EpicEditor</h3>
<p>EpicEditor needs to know where to find its themes, so it needs to be told its install directory at init.</p>
<pre><code class="lang-javascript">var editor = new EpicEditor({basePath: '/static/lib/epiceditor'}).load();
</code></pre>
<h2 id="api">API</h2>
<h3 id="epiceditor-_options_-">EpicEditor([<em>options</em>])</h3>
<p>The <code>EpicEditor</code> constructor creates a new editor instance. Customize the instance by passing the <code>options</code> parameter. The example below uses all options and their defaults:</p>
<pre><code class="lang-javascript">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);
</code></pre>
<h3 id="options">Options</h3>
<table cellspacing="0">
<tr>
<th>Option</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>container</code></td>
<td>The ID (string) or element (object) of the target container in which you want the editor to appear.</td>
<td><code>epiceditor</code></td>
</tr>
<tr>
<td><code>textarea</code></td>
<td>The ID (string) or element (object) of a textarea you would like to sync the editor's content with. On page load if there is content in the textarea, the editor will use that as its content.</td>
<td></td>
</tr>
<tr>
<td><code>basePath</code></td>
<td>The base path of the directory containing the <code>/themes</code>.</td>
<td><code>epiceditor</code></td>
</tr>
<tr>
<td><code>clientSideStorage</code></td>
<td>Setting this to false will disable localStorage.</td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>localStorageName</code></td>
<td>The name to use for the localStorage object.</td>
<td><code>epiceditor</code></td>
</tr>
<tr>
<td><code>useNativeFullscreen</code></td>
<td>Set to false to always use faux fullscreen (the same as what is used for unsupported browsers).</td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>parser</code></td>
<td><a href="https://github.com/chjj/marked">Marked</a> is the only parser built into EpicEditor, but you can customize or toggle this by passing a parsing function to this option. For example:<br><code>parser: MyCustomParser.parse</code></td>
<td><code>marked</code></td>
</tr>
<tr>
<td><code>focusOnLoad</code></td>
<td>If <code>true</code>, editor will focus on load.</td>
<td><code>false</code></td>
</tr>
<tr>
<td><code>file.name</code></td>
<td>If no file exists with this name a new one will be made, otherwise the existing will be opened.</td>
<td>container ID</td>
</tr>
<tr>
<td><code>file.defaultContent</code></td>
<td>The content to show if no content exists for a file. NOTE: if the <code>textarea</code> option is used, the textarea's value will take precedence over <code>defaultContent</code>.</td>
<td></td>
</tr>
<tr>
<td><code>file.autoSave</code></td>
<td>How often to auto save the file in milliseconds. Set to <code>false</code> to turn it off.</td>
<td><code>100</code></td>
</tr>
<tr>
<td><code>theme.base</code></td>
<td>The base styles such as the utility bar with the buttons.</td>
<td><code>themes/base/epiceditor.css</code></td>
</tr>
<tr>
<td><code>theme.editor</code></td>
<td>The theme for the editor which is the area you type into.</td>
<td><code>themes/editor/epic-dark.css</code></td>
</tr>
<tr>
<td><code>theme.preview</code></td>
<td>The theme for the previewer.</td>
<td><code>themes/preview/github.css</code></td>
</tr>
<tr>
<td><code>button</code></td>
<td>If set to <code>false</code> will remove all buttons.</td>
<td>All buttons set to <code>true</code>.</td>
</tr>
<tr>
<td><code>button.preview</code></td>
<td>If set to <code>false</code> will remove the preview button.</td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>button.fullscreen</code></td>
<td>If set to <code>false</code> will remove the fullscreen button.</td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>button.bar</code></td>
<td>If <code>true</code> or <code>"show"</code>, any defined buttons will always be visible. If <code>false</code> or <code>"hide"</code>, any defined buttons will never be visible. If <code>"auto"</code>, buttons will usually be hidden, but shown if whenever the mouse is moved.</td>
<td><code>"auto"</code></td>
</tr>
<tr>
<td><code>shortcut.modifier</code></td>
<td>The key to hold while holding the other shortcut keys to trigger a key combo.</td>
<td><code>18</code> (<code>alt</code> key)</td>
</tr>
<tr>
<td><code>shortcut.fullscreen</code></td>
<td>The shortcut to open fullscreen.</td>
<td><code>70</code> (<code>f</code> key)</td>
</tr>
<tr>
<td><code>shortcut.preview</code></td>
<td>The shortcut to toggle the previewer.</td>
<td><code>80</code> (<code>p</code> key)</td>
</tr>
<tr>
<td><code>string.togglePreview</code></td>
<td>The tooltip text that appears when hovering the preview icon.</td>
<td><code>Toggle Preview Mode</code></td>
</tr>
<tr>
<td><code>string.toggleEdit</code></td>
<td>The tooltip text that appears when hovering the edit icon.</td>
<td><code>Toggle Edit Mode</code></td>
</tr>
<tr>
<td><code>string.toggleFullscreen</code></td>
<td>The tooltip text that appears when hovering the fullscreen icon.</td>
<td><code>Enter Fullscreen</code></td>
</tr>
<tr>
<td><code>autogrow</code></td>
<td>Whether to autogrow EpicEditor to fit its contents. If autogrow is desired one can either specify <code>true</code>, meaning to use default autogrow settings, or an object to define custom settings</td>
<td><code>false</code></td>
</tr>
<tr>
<td><code>autogrow.minHeight</code></td>
<td>The minimum height (in pixels) that the editor should ever shrink to. This may also take a function that returns the desired minHeight if this is not a constant, or a falsey value if no minimum is desired</td>
<td><code>80</code></td>
</tr>
<tr>
<td><code>autogrow.maxHeight</code></td>
<td>The maximum height (in pixels) that the editor should ever grow to. This may also take a function that returns the desired maxHeight if this is not a constant, or a falsey value if no maximum is desired</td>
<td><code>false</code></td>
</tr>
<tr>
<td><code>autogrow.scroll</code></td>
<td>Whether the page should scroll to keep the caret in the same vertical place while autogrowing (recommended for mobile in particular)</td>
<td><code>true</code></td>
</tr>
</table>
<h3 id="load-_callback_-">load([<em>callback</em>])</h3>
<p>Loads the editor by inserting it into the DOM by creating an <code>iframe</code>. Will trigger the <code>load</code> event, or you can provide a callback.</p>
<pre><code class="lang-javascript">editor.load(function () {
console.log("Editor loaded.")
});
</code></pre>
<h3 id="unload-_callback_-">unload([<em>callback</em>])</h3>
<p>Unloads the editor by removing the <code>iframe</code>. Keeps any options and file contents so you can easily call <code>.load()</code> again. Will trigger the <code>unload</code> event, or you can provide a callback.</p>
<pre><code class="lang-javascript">editor.unload(function () {
console.log("Editor unloaded.")
});
</code></pre>
<h3 id="getelement-_element_-">getElement(<em>element</em>)</h3>
<p>Grabs an editor element for easy DOM manipulation. See the Themes section below for more on the layout of EpicEditor elements.</p>
<ul>
<li><code>container</code>: The element given at setup in the options.</li>
<li><code>wrapper</code>: The wrapping <code><div></code> containing the 2 editor and previewer iframes.</li>
<li><code>wrapperIframe</code>: The iframe containing the <code>wrapper</code> element.</li>
<li><code>editor</code>: The #document of the editor iframe (i.e. you could do <code>editor.getElement('editor').body</code>).</li>
<li><code>editorIframe</code>: The iframe containing the <code>editor</code> element.</li>
<li><code>previewer</code>: The #document of the previewer iframe (i.e. you could do <code>editor.getElement('previewer').body</code>).</li>
<li><code>previewerIframe</code>: The iframe containing the <code>previewer</code> element.</li>
</ul>
<pre><code class="lang-javascript">someBtn.onclick = function () {
console.log(editor.getElement('editor').body.innerHTML); // Returns the editor's content
}
</code></pre>
<h3 id="is-_state_-">is(<em>state</em>)</h3>
<p>Returns a boolean for the requested state. Useful when you need to know if the editor is loaded yet for example. Below is a list of supported states:</p>
<ul>
<li><code>loaded</code></li>
<li><code>unloaded</code></li>
<li><code>edit</code></li>
<li><code>preview</code></li>
<li><code>fullscreen</code></li>
</ul>
<pre><code class="lang-javascript">fullscreenBtn.onclick = function () {
if (!editor.is('loaded')) { return; }
editor.enterFullscreen();
}
</code></pre>
<h3 id="open-_filename_-">open(<em>filename</em>)</h3>
<p>Opens a client side storage file into the editor.</p>
<p><strong>Note:</strong> This does <em>not</em> open files on your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">openFileBtn.onclick = function () {
editor.open('some-file'); // Opens a file when the user clicks this button
}
</code></pre>
<h3 id="importfile-_filename_-_content_-">importFile([<em>filename</em>],[<em>content</em>])</h3>
<p>Imports a string of content into a client side storage file. If the file already exists, it will be overwritten. Useful if you want to inject a bunch of content via AJAX. Will also run <code>.open()</code> after import automatically.</p>
<p><strong>Note:</strong> This does <em>not</em> import files on your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">importFileBtn.onclick = function () {
editor.importFile('some-file',"#Imported markdown\nFancy, huh?"); //Imports a file when the user clicks this button
}
</code></pre>
<h3 id="exportfile-_filename_-_type_-">exportFile([<em>filename</em>],[<em>type</em>])</h3>
<p>Returns the plain text of the client side storage file, or if given a <code>type</code>, will return the content in the specified type. If you leave both parameters <code>null</code> it will return the current document's content in plain text. The supported export file types are:</p>
<p><strong>Note:</strong> This does <em>not</em> export files to your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<ul>
<li>text (default)</li>
<li>html</li>
<li>json (includes metadata)</li>
<li>raw (warning: this is browser specific!)</li>
</ul>
<pre><code class="lang-javascript">syncWithServerBtn.onclick = function () {
var theContent = editor.exportFile();
saveToServerAjaxCall('/save', {data:theContent}, function () {
console.log('Data was saved to the database.');
});
}
</code></pre>
<h3 id="rename-_oldname_-_newname_-">rename(<em>oldName</em>, <em>newName</em>)</h3>
<p>Renames a client side storage file.</p>
<p><strong>Note:</strong> This does <em>not</em> rename files on your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">renameFileBtn.onclick = function () {
var newName = prompt('What do you want to rename this file to?');
editor.rename('old-filename.md', newName); //Prompts a user and renames a file on button click
}
</code></pre>
<h3 id="save-">save()</h3>
<p>Manually saves a file to client side storage (localStorage by default). EpicEditor will save continuously every 100ms by default, but if you set <code>autoSave</code> in the options to <code>false</code> or to longer intervals it's useful to manually save.</p>
<p><strong>Note:</strong> This does <em>not</em> save files to your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">saveFileBtn.onclick = function () {
editor.save();
}
</code></pre>
<h3 id="remove-_name_-">remove(<em>name</em>)</h3>
<p>Deletes a client side storage file.</p>
<p><strong>Note:</strong> This does <em>not</em> remove files from your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">removeFileBtn.onclick = function () {
editor.remove('example.md');
}
</code></pre>
<h3 id="getfiles-_name_-_excludecontent_-">getFiles([<em>name</em>], [<em>excludeContent</em>])</h3>
<p>If no <code>name</code> is given it returns an object containing the names and metadata of all client side storage file objects. If a <code>name</code> is specified it will return just the metadata of that single file object. If <code>excludeContent</code> is true, it will remove the content from the returned object. This is useful when you just want a list of files or get some meta data. If <code>excludeContent</code> is false (default), it'll return a <code>content</code> property per file in plain text format.</p>
<p><strong>Note:</strong> This does <em>not</em> get files from your server or machine (yet). This simply looks in localStorage where EpicEditor stores drafts.</p>
<pre><code class="lang-javascript">var files = editor.getFiles();
for (x in files) {
console.log('File: ' + x); //Returns the name of each file
};
</code></pre>
<h3 id="on-_event_-_handler_-">on(<em>event</em>, <em>handler</em>)</h3>
<p>Sets up an event handler (callback) for a specified event. For all event types, see the Events section below.</p>
<pre><code class="lang-javascript">editor.on('unload', function () {
console.log('Editor was removed');
});
</code></pre>
<h3 id="emit-_event_-">emit(<em>event</em>)</h3>
<p>Fires an event programatically. Similar to jQuery's <code>.trigger()</code></p>
<pre><code class="lang-javascript">editor.emit('unload'); // Triggers the handler provided in the "on" method above
</code></pre>
<h3 id="removelistener-_event_-_handler_-">removeListener(<em>event</em>, [<em>handler</em>])</h3>
<p>Allows you to remove all listeners for an event, or just the specified one.</p>
<pre><code class="lang-javascript">editor.removeListener('unload'); //The handler above would no longer fire
</code></pre>
<h3 id="preview-">preview()</h3>
<p>Puts the editor into preview mode.</p>
<pre><code class="lang-javascript">previewBtn.onclick = function () {
editor.preview();
}
</code></pre>
<h3 id="edit-">edit()</h3>
<p>Puts the editor into edit mode.</p>
<pre><code class="lang-javascript">editBtn.onclick = function () {
editor.edit();
}
</code></pre>
<h3 id="focus-">focus()</h3>
<p>Puts focus on the editor or previewer (whichever is visible). Works just like
doing plain old JavaScript and input focus like <code>someInput.focus()</code>. The
benefit of using this method however, is that it handles cross browser issues
and also will focus on the visible view (edit or preview).</p>
<pre><code>showEditorBtn.onclick = function () {
editorWrapper.style.display = 'block'; // switch from being hidden from the user
editor.focus(); // Focus and allow user to start editing right away
}
</code></pre><h3 id="enterfullscreen-callback-">enterFullscreen([callback])</h3>
<p>Puts the editor into fullscreen mode. A callback will be fired after the entering fullscreen animation completes. Some browsers
will be nearly instant while others, mainly Chrome, take 750ms before this event is fired. If already in fullscreen, the
callback will fire immediately.</p>
<p><strong>Note:</strong> due to browser security restrictions, calling <code>enterFullscreen</code> programmatically
like this will not trigger native fullscreen. Native fullscreen can only be triggered by a user interaction like mousedown or keyup.</p>
<pre><code class="lang-javascript">enterFullscreenBtn.onclick = function () {
editor.enterFullscreen(function () {
console.log('Welcome to fullscreen mode!');
});
}
</code></pre>
<h3 id="exitfullscreen-callback-">exitFullscreen([callback])</h3>
<p>Closes fullscreen mode. A callback will be fired after the exiting fullscreen animation completes. If already not in fullscreen, the
callback will fire immediately.</p>
<pre><code class="lang-javascript">exitFullscreenBtn.onclick = function () {
editor.exitFullscreen(function () {
console.log('Finished closing fullscreen!');
});
}
</code></pre>
<h3 id="reflow-type-callback-">reflow([type], [callback])</h3>
<p><code>reflow()</code> allows you to "reflow" the editor in it's container. For example, let's say you increased
the height of your wrapping element and want the editor to resize too. You could call <code>reflow</code>
and the editor will resize to fit. You can pass it one of two strings as the first parameter to
constrain the reflow to either <code>width</code> or <code>height</code>.</p>
<p>It also provides you with a callback parameter if you'd like to do something after the resize is finished.
The callback will return the new width and/or height in an object. Additionally, you can also listen for
the <code>reflow</code> event. This will also give you back the new size.</p>
<p><strong>Note:</strong> If you call <code>reflow()</code> or <code>reflow('width')</code> and you have a fluid width container
EpicEditor will no longer be fluid because doing a reflow on the width sets an inline style on the editor.</p>
<pre><code class="lang-javascript">// For an editor that takes up the whole browser window:
window.onresize = function () {
editor.reflow();
}
// Constrain the reflow to just height:
someDiv.resizeHeightHandle = function () {
editor.reflow('height');
}
// Same as the first example, but this has a callback
window.onresize = function () {
editor.reflow(function (data) {
console.log('width: ', data.width, ' ', 'height: ', data.height);
});
}
</code></pre>
<h2 id="events">Events</h2>
<p>You can hook into specific events in EpicEditor with <a href="#onevent-handler"><code>on()</code></a> such as when a file is
created, removed, or updated. Below is a complete list of currently supported events and their description.</p>
<table cellspacing="0" class="event-table">
<tr>
<th>Event Name</th>
<th>Description</th>
</tr>
<tr>
<td><code>create</code></td>
<td>Fires whenever a new file is created.</td>
</tr>
<tr>
<td><code>read</code></td>
<td>Fires whenever a file is read.</td>
</tr>
<tr>
<td><code>update</code></td>
<td>Fires whenever a file is updated.</td>
</tr>
<tr>
<td><code>remove</code></td>
<td>Fires whenever a file is deleted.</td>
</tr>
<tr>
<td><code>load</code></td>
<td>Fires when the editor loads via <code>load()</code>.</td>
</tr>
<tr>
<td><code>unload</code></td>
<td>Fires whenever the editor is unloaded via <code>unload()</code></td>
</tr>
<tr>
<td><code>preview</code></td>
<td>Fires whenever the previewer is opened (excluding fullscreen) via <code>preview()</code> or the preview button.</td>
</tr>
<tr>
<td><code>edit</code></td>
<td>Fires whenever the editor is opened (excluding fullscreen) via <code>edit()</code> or the edit button.</td>
</tr>
<tr>
<td><code>fullscreenenter</code></td>
<td>Fires whenever the editor opens in fullscreen via <code>fullscreen()</code> or the fullscreen button.</td>
</tr>
<tr>
<td><code>fullscreenexit</code></td>
<td>Fires whenever the editor closes in fullscreen via <code>fullscreen()</code> or the fullscreen button.</td>
</tr>
<tr>
<td><code>save</code></td>
<td>Fires whenever <code>save()</code> is called manually, or implicitly by <code>importFile</code> or <code>open</code>.</td>
</tr>
<tr>
<td><code>autosave</code></td>
<td>Fires whenever the autoSave interval fires, and the file contents have been updated since the last save.</td>
</tr>
<tr>
<td><code>open</code></td>
<td>Fires whenever a file is opened or loads automatically by EpicEditor or when <code>open()</code> is called.</td>
</tr>
<tr>
<td><code>reflow</code></td>
<td>Fires whenever <code>reflow()</code> is called. Will return the new dimensions in the callback. Will also fire every time there is a resize from autogrow.</td>
</tr>
</table>
<h2 id="themes">Themes</h2>
<p>Theming is easy in EpicEditor. There are three different <code><iframe></code>s which means styles wont leak between the "chrome" of
EpicEditor, previewer, or editor. Each one is like it's own web page. In the <code>themes</code> directory you'll see <code>base</code>, <code>preview</code>, and
<code>editor</code>. The base styles are for the "chrome" of the editor which contains elements such as the utility bar containing the icons.
The editor is the styles for the contents of editor <code><iframe></code> and the preview styles are applied to the preview <code><iframe></code>.</p>
<p>The HTML of a generated editor (excluding contents) looks like this:</p>
<pre><code class="lang-html"><div id="container">
<iframe id="epiceditor-instance-id">
<html>
<head>
<link type="text/css" id="" rel="stylesheet" href="epiceditor/themes/base/epiceditor.css" media="screen">
</head>
<body>
<div id="epiceditor-wrapper">
<iframe id="epiceditor-editor-frame">
<html>
<head>
<link type="text/css" rel="stylesheet" href="epiceditor/themes/editor/epic-dark.css" media="screen">
</head>
<body contenteditable="true">
<!-- raw content -->
</body>
</html>
</iframe>
<iframe id="epiceditor-previewer-frame">
<html>
<head>
<link type="text/css" rel="stylesheet" href="epiceditor/themes/preview/github.css" media="screen">
</head>
<body>
<div id="epiceditor-preview" class="epiceditor-preview">
<!-- rendered html -->
</div>
</body>
</html>
</iframe>
<div id="epiceditor-utilbar">
<span title="Toggle Preview Mode" class="epiceditor-toggle-btn epiceditor-toggle-preview-btn"></span>
<span title="Enter Fullscreen" class="epiceditor-fullscreen-btn"></span>
</div>
</div>
</body>
</html>
</iframe>
</div>
</code></pre>
<p>Unlike the "chrome" of <code>base</code> or <code>editor</code>, the theming of the <code>preview</code> is done by CSS class so that
you can reuse EpicEditor's theme to make your rendered page match your previewed.</p>
<p>First, include your chosen theme on every page:</p>
<pre><code class="lang-html"><link rel="stylesheet" href="/epiceditor/themes/preview/github.css">
</code></pre>
<p>(you may need to adjust the path)</p>
<p>Mark your rendered content with <code>.epiceditor-preview</code>:</p>
<pre><code class="lang-html"><div id="my-content" class="epiceditor-preview"> ... </div>
</code></pre>
<h2 id="custom-parsers">Custom Parsers</h2>
<p>EpicEditor is set up to allow you to use any parser that accepts and returns a string. This means you can use any flavor of Markdown, process Textile, or even create a simple HTML editor/previewer (<code>parser: false</code>). The possibilities are endless. Just make the parser available and pass its parsing function to the EpicEditor setting and you should be all set. You can output plain text or HTML. Here's an example of a parser that could remove "bad words" from the preview:</p>
<pre><code class="lang-js">var editor = new EpicEditor({
parser: function (str) {
var blacklist = ['foo', 'bar', 'baz'];
return str.split(' ').map(function (word) {
// If the word exists, replace with asterisks
if (blacklist.indexOf(word) > -1) {
return '****'
}
return word;
}).join(' ');
}
}).load();
</code></pre>
<p>Here's a <a href="http://remysharp.com/2008/04/01/wiki-to-html-using-javascript/">Wiki to HTML</a> parser by Remy Sharp used with EpicEditor:</p>
<pre><code class="lang-js">var editor = new EpicEditor({
parser: function (str) {
return str.wiki2html();
}
}).load();
</code></pre>
<p>For even more customization and optimization you can replace the default built-in processor on build. Running <code>jake build parser=path/to/parser.js</code> will override the default Marked build and replace it with your custom script.</p>
<h2 id="support">Support</h2>
<p>If you're having any problems with EpicEditor feel free to open a <a href="http://github.com/OscarGodson/EpicEditor/issues/new">new ticket</a>. Go ahead and ask us anything and we'll try to help however we can. You can also see if there's someone available at the #epiceditor IRC channel on irc.freenode.net. If you need a little more help with implementing EpicEditor on your site we've teamed up with <a href="http://codersclan.net">CodersClan</a> to offer support:</p>
<p><a href="http://codersclan.net/support/step1.php?repo_id=2"><img src="http://www.codersclan.net/graphics/getSupport_blue_big.png" width="160"></a></p>
<h2 id="contributing">Contributing</h2>
<p>Contributions are greatly encouraged and appreciated. For more on ways to contribute please check the wiki: <a href="https://github.com/OscarGodson/EpicEditor/wiki/Contributing">Contributing Guide</a>.</p>
<h2 id="credits">Credits</h2>
<p>EpicEditor relies on <a href="https://github.com/chjj/marked">Marked</a> to parse markdown and is brought to you in part by <a href="http://twitter.com/oscargodson">Oscar Godson</a> and <a href="http://twitter.com/johnmdonahue">John Donahue</a>. Special thanks to <a href="http://twitter.com/adam_bickford">Adam Bickford</a> for the bug fixes and being the QA for pull requests. Lastly, huge thanks to <a href="http://twitter.com/sebnitu">Sebastian Nitu</a> for the amazing logo and doc styles.</p>
<div id="avatars">
</div>
<a href="http://github.com/OscarGodson/EpicEditor"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/7afbc8b248c68eb468279e8c17986ad46549fb71/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub"></a>
<script src="docs/js/jquery.min.js"></script>
<script src="docs/js/prettify.js"></script>
<script src="epiceditor/js/epiceditor.js"></script>
<script src="docs/js/main.js"></script>
</body>
</html>