You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,36 @@ A drop-in JavaScript textarea replacement for writing beautiful and understandab
8
8
## Why not a WYSIWYG editor or pure Markdown?
9
9
WYSIWYG editors that produce HTML are often complex and buggy. Markdown solves this problem in many ways, plus Markdown can be rendered natively on more platforms than HTML. However, Markdown is not a syntax that an average user will be familiar with, nor is it visually clear while editing. In otherwords, for an unfamiliar user, the syntax they write will make little sense until they click the preview button. SimpleMDE has been designed to bridge this gap for non-technical users who are less familiar with or just learning Markdown syntax.
10
10
11
-
## Quick start
12
-
SimpleMDE is available on [npm](https://www.npmjs.com/package/simplemde).
11
+
## Install
12
+
13
+
Via [npm](https://www.npmjs.com/package/simplemde).
13
14
```
14
15
npm install simplemde --save
15
16
```
16
17
17
-
SimpleMDE is also available on [jsDelivr](http://www.jsdelivr.com/#!simplemde). *Please note, jsDelivr may take a few days to update to the latest release.*
18
+
Via [bower](https://www.bower.io).
19
+
```
20
+
bower install simplemde --save
21
+
```
22
+
23
+
Via [jsDelivr](http://www.jsdelivr.com/#!simplemde). *Please note, jsDelivr may take a few days to update to the latest release.*
The following methods will let you check on the state of the editor.
216
+
217
+
```js
218
+
var simplemde =newSimpleMDE();
219
+
simplemde.isPreviewActive();
220
+
simplemde.isSideBySideActive();
221
+
simplemde.isFullscreenActive();
222
+
```
223
+
206
224
## How it works
207
225
SimpleMDE is an improvement of [lepture's Editor project](https://github.com/lepture/editor) and includes a great many number of changes. It is bundled with [CodeMirror](https://github.com/codemirror/codemirror) and depends on [Font Awesome](http://fortawesome.github.io/Font-Awesome/).
0 commit comments