slate-markdown

Add live markdown preview to your Slate editor.

Demo: slate-markdown.spectrum.chat

Installation

``sh
npm install slate-markdown
`

Usage

`javascript
import { Editor } from 'slate';
import MarkdownPlugin from 'slate-markdown';

const markdown = MarkdownPlugin();

plugins={[markdown]}
/>
`

Options

$3

(default: ['2.441em', '1.953em', '1.563em', '1.25em', '1em'])

A list of sizes to use for the headings, the index + 1 is used for the level

`javascript
const markdown = MarkdownPlugin({
// This is the default:
sizes: ['2.441em', '1.953em', '1.563em', '1.25em', '1em'],
// ^ h1 ^ h2 ^ h3 ^ h4 ^ h5
})
`

$3

An object containing additional classnames to attach to the rendered components. Useful to adapt the styling.

`javascript
const markdown = MarkdownPlugin({
classnames: {
// When a title is rendered it will now have a .custom-title className
title: 'custom-title',
}
})
`

Possible keys are for the object are:

`javascript
'title' | 'bold' | 'italic' | 'punctuation' | 'code' | 'list' | 'hr' | 'url'
`

$3

(default: true)

This plugin uses PrismJS for highlighting the markdown. By default the Prism markdown grammar extends the markup grammar, and thusly supports things like s,