marky-editor v0.2.0

Marky Markdown Editor

A simple Markdown editor build around the awsome CodeMirror Editor.

Example

Install

# include in your package
npm install janstuemmel/marky-editor

# via github
git clone https://github.com/janstuemmel/marky-editor.git
npm install && npm test

# run automatic tests in chrome
TEST_BROWSERS=Chrome gulp test-auto

Usage

// insert css into your html 
// required: node_modules/marky-editor/dist/marky.css
// optional: node_modules/marky-editor/dist/marky.editor.themes.css

var Marky = require('marky-editor');
var marky = new Marky(document.body, '# Hello world');

or look into the example

API

marky.on('marky.editor.change', function() {
  console.log('content changed');
});

Todo

• tests, tests, tests
• seperate Editor / Viewer
• resize split view
• highlight code inside preview
• make a proper config module
• extend api
• file import/export
• printing
• register on npm
• able to register plugins in the editor
• mathjax support
• install eslint
• markdown templates