Skip to content

chinmaymk/rmarkdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rmarkdown

Instant markdown to html. Written in pure javascript, no css, no jquery, no nothing, and really tiny - 942 bytes, compressed and minified.

##Installation Grab the zip from github, copy dist/rmarkdown.min.js to your js folder and refer it from you page. Only dependency is marked, and if you like syntax highlighting refer highlight.js

<script src="http://cdnjs.cloudflare.com/ajax/libs/marked/0.3.2/marked.min.js"></script>
<script src="path/to/js/rmarkdown.min.js" type="text/javascript"></script>

##Usage

<div id="rmarkdown"></div>
<script type="text/javascript">
  //needs a dom element, not jquery selector
  var editor = new rmarkdown({
    el: document.getElementById('rmarkdown'), //the element where you need editor
    value : '#Hello World' //initial value, editor will be initiated with this value
  });  
</script>

That's about it.

If you would like to remove the annoying border of contenteditable divs, use this css

[contenteditable]:focus {
  outline: none;
}

api

var markdown = editor.markdown(); //returns markdown typed so far
var html = editor.html(); //returns markdown converted to html

##Todo

  • Check on other browsers than chrome, they do exist
  • Write some tests
  • Make it work on server

##Got suggestions ? Feel free to submit a pull request, file an issue, or get in touch on twitter @_chinmaymk

About

awesome editor for awesome markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published