Skip to content

weflex/markdown-editor-flavored

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

a markdown editor just like github flavored editor based on markdown-it

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published