deblan-mirror/simplemde-markdown-editor
1
0
Fork 0
mirror of https://github.com/sparksuite/simplemde-markdown-editor.git synced 2024-06-20 14:45:02 +02:00
Code Issues Projects Releases Wiki Activity

Document npm install in README

Browse source
This commit is contained in:
Wes Cossick 2015-09-02 10:50:10 -05:00
parent 8ed562431a
commit 6389777c30
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -9,12 +9,22 @@ A drop-in JavaScript textarea replacement for writing beautiful and understandab
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.
## Quick start
SimpleMDE is available on [jsDelivr](http://www.jsdelivr.com/#!simplemde). Font Awesome is available on MaxCDN. *Please note, jsDelivr may take a few days to update to the latest release.*
SimpleMDE is available on npm.
```
npm install simplemde --save
```
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.*
```HTML
<link rel="stylesheet" href="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.css">
<script src="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>
```
SimpleMDE depends on Font Awesome (load via MaxCDN for best performance).
```HTML
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/latest/css/font-awesome.min.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.css">
<script src="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>
```
And then load SimpleMDE on the first textarea on a page