Need private packages and team management tools?Check out npm Teams »

slate-md-editor

1.5.4 • Public • Published

slate-md-editor

A markdown editor, that allows you to edit live. Support markdown syntax and hot keys.

Usage

There is two ways to use, you could use it as a complete markdown editor or use as a slate plugin in your editor.

Usage

Render the complete markdown editor

import Editor from "slate-md-editor";
const MdEditor = Editor(options);
 
<MdEditor value={value} onChange={this.onChange} />;

Options

Pass your customized settings here.

slate-md-editor build on top of various slate plugins, [xxxxOption] will pass it's settings directly to corresponding plugins.

// default settings
{
  markdownOption: {
    blocks: BLOCKS, // https://github.com/GitbookIO/markup-it/blob/master/src/constants/blocks.js
    marks: MARKS, // https://github.com/GitbookIO/markup-it/blob/master/src/constants/marks.js
    inlines: INLINES, // https://github.com/GitbookIO/markup-it/blob/master/src/constants/inlines.js
  },
  prismOption: {
    // https://github.com/GitbookIO/slate-prism
    onlyIn: node => node.type === 'code_block',
    getSyntax: node => node.data.get('syntax')
  },
  codeOption: {
    // https://github.com/GitbookIO/slate-edit-code
    onlyIn: node => node.type === 'code_block'
  },
  blockquoteOption: {
    // https://github.com/GitbookIO/slate-edit-blockquote
  },
  listOption: {
    // https://github.com/GitbookIO/slate-edit-list
    types: ['ordered_list', 'unordered_list'],
    typeItem: 'list_item',
    typeDefault: 'paragraph'
  }
}

Props

  • value: Slate Value
  • onChange: (Change) => void

As slate plugin

Learn more here

Install

npm i slate-md-editor

DownloadsWeekly Downloads

50

Version

1.5.4

License

MIT

Unpacked Size

26.2 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar