Calmdown

Calmdown is a lightweight markdown editor based on showdown js with a bite of github flavor.

Quick start

• Clone the repo

  git clone https://github.com/gabemiller/calmdown.git

• Install using npm

  npm install calmdown --save

How it works

1. (Important) You should use some css normalization or reset before use Calmdown. In the demo project I used normalize.css.

2. Add this stylesheet link to head of the html. You can find this in dist/css folder.

   <link href="dist/css/calmdown.min.css" rel="stylesheet" type="text/css">

3. Add this script to the bottom of the html before close body tag. You can find this in dist/scripts folder.

   <script src="dist/scripts/calmdown.min.js"></script>

4. Create a div with classname .calmdown whereever you want

    <div class="calmdown"></div> 

5. Initialize a new instance of the Calmdown under the calmdown.min.js script tag

    <script>
       const cd = new Calmdown({
        // optional configuration
       });
    </script> 

Contribute

First things first, thank all of you who spend your time to check out Calmdown. If you find a problem or have an idea to make Calmdown better, just open a descriptive issue about it.

Moreover, pull requests are welcome too, just be sure to avoid unrelated commits.

Your contributions are truly appriciated!

Version history

Version history

License

MIT license

I would like to thank authors and contributors of these projects

• Showdown
• Mousetrap
• PrismJs
• Normalize css