3.0.0-alpha.3 • Published 7 months ago

markdown-plus v3.0.0-alpha.3

Weekly downloads
140
License
MIT
Repository
github
Last release
7 months ago

Markdown Plus

A React markdown editor and previewer.

Online Demo

Markdown Plus

Installation

yarn add markdown-plus

Usage

import MarkdownPlus from 'markdown-plus';

<MarkdownPlus markdown="# Hello world!" />;

props

markdown

Initial markdown text to load into the editor.

<MarkdownPlus markdown="# Hello world!" />

Default value is ''.

toolbar

Show, hide or remove toolbar.

<MarkdownPlus toolbar="show" />

3 possible values:

  • show: show toolbar.
  • hide: hide toolbar, show a gutter on top. Click the gutter to show toolbar.
  • none: no toolbar, no gutter.

Default value: none.

mode

Display editor, preview or both.

<MarkdownPlus mode="both" />

3 possible values:

  • both: show both editor and preview
  • editor: show editor only
  • preview: show preview only

Default value: both.

theme

Overal theme: light, dark or auto:

<MarkdownPlus theme="auto" />

3 possible values:

  • light: light theme
  • dark: dark theme
  • auto: same as system theme

Default value: auto.