mirror of
https://github.com/sparksuite/simplemde-markdown-editor.git
synced 2024-06-28 10:20:05 +02:00
Merge pull request #81 from NextStepWebs/development
Document npm install in README
This commit is contained in:
commit
4240da87c0
16
README.md
16
README.md
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue