Socket
Socket
Sign inDemoInstall

markdown-editor-shell

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

markdown-editor-shell

Client-side markdown editor shell which compatible with any renderer engine.

    1.2.1latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
10

Weekly downloads

Readme

Source

Markdown Editor Shell

Build Status Coverage Status npm version

Client-side markdown editor shell which compatible with any renderer engine.

Example of usage

var editor = new MarkdownEditorShell({
    container: 'content',
    markdownToHtmlConvertor: markdownToHtmlConvertor
});
editor.load();

Demo

Options

container

string or object, an Id of textarea element or element itself for wrapping in MarkdownEditorShell.

fullscreenButtonTitle

string, the title of fullscreen button which will be shown by mouse over. Defaults to Enter Fullscreen.

previewButtonTitle

string, the title of preview button which will be shown by mouse over. Defaults to Toggle Preview Mode.

markdownToHtmlConvertor

function that represents converter from markdown text (input parameter) to html (output value).

additionalButtons

array of groups of buttons to display in toolbar.

Each group should represent the following object:

{
    name: "", // name of group
    buttons: [ // array of group buttons
        {
            title: "Bold", // title of button
            className: "glyphicon glyphicon-bold", // class of button
            action: buttonAction(e) // a function that represents the action of button, where e is instance of plugin
        }
    ]
}

License

Markdown Editor Shell is under the MIT license.

Keywords

FAQs

Last updated on 16 Apr 2018

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc