Netsyms/easy-markdown-editor
2
0
Fork 0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-07-15 14:04:28 -06:00
Code Issues Releases Wiki Activity

Merge pull request #134 from FabianKoestring/master

Browse Source 
Added bower support
This commit is contained in:
Wes Cossick 2015-10-20 09:36:08 -05:00
commit dc78ab2c6a
2 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,11 +9,15 @@ 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. 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 ## Quick start
### Installation
#### NPM
SimpleMDE is available on [npm](https://www.npmjs.com/package/simplemde). SimpleMDE is available on [npm](https://www.npmjs.com/package/simplemde).
``` ```
npm install simplemde --save npm install simplemde --save
``` ```
#### jsDelivery
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.* 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 ```HTML
@ -21,6 +25,13 @@ SimpleMDE is also available on [jsDelivr](http://www.jsdelivr.com/#!simplemde).
<script src="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script> <script src="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>
``` ```
#### Bower
SimpleMDE is also available via [Bower](http://bower.io/).
```console
bower install simplemde-markdown-editor
```
### Usage
And then load SimpleMDE on the first textarea on a page And then load SimpleMDE on the first textarea on a page
```HTML ```HTML
@ -110,7 +121,7 @@ var simplemde = new SimpleMDE({
setTimeout(function(){ setTimeout(function(){
preview.innerHTML = customMarkdownParser(plainText); preview.innerHTML = customMarkdownParser(plainText);
}, 250); }, 250);
return "Loading..."; return "Loading...";
} }
renderingConfig: { renderingConfig: {

27
bower.json Normal file
View File

@ -0,0 +1,27 @@
{
"name": "simplemde-markdown-editor",
"version": "1.7.4",
"homepage": "https://github.com/NextStepWebs/simplemde-markdown-editor",
"authors": [
"Wes Cossik <support@nextstepwebs.com>"
],
"description": "A simple, beautiful, and embeddable JavaScript markdown editor.",
"main": ["dist/simplemde.min.js", "dist/simplemde.min.css"],
"moduleType": [
"globals"
],
"keywords": [
"wysiwyg",
"markdown",
"editor",
"js"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
]
}