Code Monkey home page Code Monkey logo

markdown-editor-flavored's Introduction

Markdown Editor

A markdown editor integrate write and preview tabs like Github's flavored editor.

Live Demo

Install

$ npm install markdown-editor-flavored
$ bower install markdown-editor-flavored

Usage

Define your div element as the editor replacement.

<div id="markdown-editor-sample"></div>

And write JavaScript:

var editor = new MarkdownEditor('#markdown-editor-sample', {
  // this is optional
  'width': '100%',
  'margin': '5px'
});
editor.render();

You can specify the width of editor by calling the .render function with an argument like:

editor.render('auto');
// or
editor.render('500px');

Environment Variables

MARKDOWN_EDITOR_FLAVORED_STYLE_PATH: to change the root path to search style, the usage:

window.MARKDOWN_EDITOR_FLAVORED_STYLE_PATH = 'your_root_dir';

MARKDOWN_EDITOR_DISABLE_AUTO_LOAD_STYLE: to disable the auto load of styles(markdown-editor.css), the usage:

window.MARKDOWN_EDITOR_DISABLE_AUTO_LOAD_STYLE = true;

(This is used for some custom tools to load the style in their working group, like concat).

Screenshots

Preview UI Write UI

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.