@accordproject/markdown-editor NPM

This repo contains two React-based editors: 1. A WYSIWYG Slate-based editor that edits rich text and calls an onChange callback with the modified Slate DOM. 2. A TextArea-based markdown editor that edits markdown text and calls an onChange callback with the modified markdown text.

The demo editor uses the markdown-transform package to transform Slate DOM to/from markdown text.

Using these editors you could allow people to either edit rich formatted text using markdown (and provide a WYSIWYG preview), or allow them to edit using a WYSIWYG editor and use markdown for persistence.

The editor includes a formatting toolbar.

This component is Apache-2 licensed Open Source. Contributors welcome!

Demo

Usage

npm install @accordproject/markdown-editor

You'll also need to be sure to install this package's peer dependencies:

npm install react react-dom slate slate-react styled-components

import { SlateAsInputEditor } from '@accordproject/markdown-editor';
import List from '@accordproject/markdown-editor/dist/plugins/list';
import Video from '@accordproject/markdown-editor/dist/plugins/video';
import { SlateTransformer } from '@accordproject/markdown-slate';

const plugins = [List()];
const slateTransformer = new SlateTransformer();

function storeLocal(slateValue) {
  const markdown = slateTransformer.toMarkdown(slateValue);
  localStorage.setItem('markdown-editor', markdown);
}

ReactDOM.render(<SlateAsInputEditor plugins={plugins} lockText={false} onChange={storeLocal}/>
, document.getElementById('root'));

Example

For an example React App see the ./examples/ folder.

A TextArea containing CommonMark synchronized with a MarkdownEditor component, rendered using Slate.

overview image

In order to run an isolated local development example, run npm run dev and then navigate to: http://localhost:3001/

Available Scripts

In the project directory, you can run:

`npm run dev`

Runs the app in the development mode. Open http://localhost:3001/ to view it in the browser.

The page will reload if you make edits.

`npm run build`

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

Styling

You can style the toolbar of this component, as well as the width of the editor:

`editorProps`

This is an object with the following possible css inputs as strings:

BUTTON_BACKGROUND_INACTIVE
BUTTON_BACKGROUND_ACTIVE
BUTTON_SYMBOL_INACTIVE
BUTTON_SYMBOL_ACTIVE
DROPDOWN_COLOR
TOOLBAR_BACKGROUND
EDITOR_BORDER_RADIUS
EDITOR_BORDER
EDITOR_HEIGHT
EDITOR_MARGIN
EDITOR_SHADOW
EDITOR_WIDTH
TOOLTIP_BACKGROUND
TOOLTIP
TOOLBAR_SHADOW

Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.

Learn More About Accord Project

Overview

Documentation

Ecosystem

Core libraries:

UI Components:

Template Editors:

Public templates and models:

Documentation:

Contributing

The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.

Find out what’s coming on our blog.

Join the Accord Project Technology Working Group Slack channel to get involved!

For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.

License

Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).

immutable is-hotkey css-loader prop-types style-loader @babel/runtime semantic-ui-css semantic-ui-react slate-plain-serializer react-textarea-autosize react-immutable-proptypes @accordproject/markdown-html @accordproject/markdown-slate

@everything-registry/sub-chunk-24 @accordproject/cicero-ui

0.92.3-20200611022905

6 years ago

0.92.3-20200609221953

6 years ago

0.92.3-20200608224932

6 years ago

0.92.3-20200608223737

6 years ago

0.92.3-20200608222555

6 years ago

0.92.3-20200608223626

6 years ago

0.92.3-20200608224532

6 years ago

0.92.3-20200608223219

6 years ago

0.92.3-20200608052028

6 years ago

0.92.3-20200608224318

6 years ago

0.92.3-20200608224137

6 years ago

0.92.3-20200604220050

6 years ago

0.92.3-20200603212756

6 years ago

0.92.3-20200603193023

6 years ago

0.92.3-20200603125543

6 years ago

0.92.3-20200602214846

6 years ago

0.92.3-20200602044630

6 years ago

0.92.3-20200601224124

6 years ago

0.92.2-20200528192333

6 years ago

0.92.3-20200527154150

6 years ago

0.92.3-20200526223358

6 years ago

0.92.2

6 years ago

0.92.2-20200526221913

6 years ago

0.92.2-20200526220342

6 years ago

0.92.2-20200526161018

6 years ago

0.92.2-20200526220016

6 years ago

0.92.2-20200522223151

6 years ago

0.92.2-20200522200933

6 years ago

0.92.2-20200522170029

6 years ago

0.92.2-20200522165555

6 years ago

0.92.2-20200522163736

6 years ago

0.92.2-20200522162623

6 years ago

0.92.2-20200522161851

6 years ago

0.92.2-20200522151920

6 years ago

0.92.2-20200522150252

6 years ago

0.92.2-20200522041529

6 years ago

0.92.2-20200522041324

6 years ago

0.92.2-20200520151329

6 years ago

0.92.2-20200520143920

6 years ago

0.92.2-20200520140358

6 years ago

0.9.18-20200519131530

6 years ago

0.92.1-20200515213248

6 years ago

0.91.1-20200515141514

6 years ago

0.91.1-20200515163309

6 years ago

0.91.1-20200515140518

6 years ago

0.92.2-20200515225311

6 years ago

0.91.1-20200515120552

6 years ago

0.92.1-20200515222504

6 years ago

0.92.1-20200515180035

6 years ago

0.91.1-20200515172837

6 years ago

0.92.0

6 years ago

0.92.1

6 years ago

0.92.1-20200515224640

6 years ago

0.92.1-20200515224611

6 years ago

0.92.1-20200515214836

6 years ago

0.92.1-20200515212539

6 years ago

0.91.1-20200514222339

6 years ago

0.91.1-20200514211704

6 years ago

0.91.1-20200514210946

6 years ago

0.91.1-20200514201047

6 years ago

0.91.1-20200514200253

6 years ago

0.91.1-20200514200132

6 years ago

0.91.1-20200514192932

6 years ago

0.91.1-20200514191915

6 years ago

0.90.1-20200514190632

6 years ago

0.90.1-20200514190616

6 years ago

0.91.1-20200514190556

6 years ago

0.90.1-20200514190355

6 years ago

0.90.1-20200514180836

6 years ago

0.91.0

6 years ago

0.90.1-20200514145545

6 years ago

0.90.1-20200514145344

6 years ago

0.90.1-20200514133102

6 years ago

0.90.1-20200514013048

6 years ago

0.90.1-20200514012942

6 years ago

0.90.1-20200514012831

6 years ago

0.90.1-20200514012458

6 years ago

0.90.1-20200514012313

6 years ago

0.90.1-20200514011142

6 years ago

0.90.1-20200513152913

6 years ago

0.90.1-20200513202138

6 years ago

0.90.1-20200513144844

6 years ago

0.90.1-20200513205512

6 years ago

0.90.1-20200513125819

6 years ago

0.90.1-20200513153756

6 years ago

0.90.1-20200513155006

6 years ago

0.90.1-20200513130307

6 years ago

0.90.1-20200513144641

6 years ago

0.90.1-20200513073637

6 years ago

0.90.1-20200513054100

6 years ago

0.90.1-20200513053734

6 years ago

0.90.1-20200513010012

6 years ago

0.90.1-20200512232344

6 years ago

0.90.1-20200512232134

6 years ago

0.90.1-20200512231442

6 years ago

0.90.1-20200512230700

6 years ago

0.90.1-20200512225800

6 years ago

0.90.1-20200512225627

6 years ago

0.90.1-20200512223519

6 years ago

0.90.1-20200512222628

6 years ago

0.90.1-20200512222427

6 years ago

0.90.1-20200512213849

6 years ago

0.90.1-20200512203821

6 years ago

0.90.1-20200512202909

6 years ago

0.90.1-20200512202609

6 years ago

0.90.1-20200511221418

6 years ago

0.9.18-20200511185451

6 years ago

0.90.1-20200511222014

6 years ago

0.90.1-20200511212127

6 years ago

0.9.18-20200508153736

6 years ago

0.9.18-20200507215539

6 years ago

0.9.18-20200507215121

6 years ago

0.9.18-20200506222905

6 years ago

0.9.18-20200506222301

6 years ago

0.9.18-20200506200807

6 years ago

0.9.18-20200506195917

6 years ago

0.9.18-20200501171733

6 years ago

0.9.18-20200501200626

6 years ago

0.9.18-20200501154618

6 years ago

0.9.18-20200430145919

6 years ago

0.9.18-20200429195104

6 years ago

0.9.18-20200429194046

6 years ago

0.9.18-20200429192440

6 years ago

0.9.18-20200429150624

6 years ago

0.9.18-20200429132639

6 years ago

0.9.18-20200428213509

6 years ago

0.9.18-20200424230108

6 years ago

0.9.18-20200424225548

6 years ago

0.9.18-20200424224756

6 years ago

0.9.18-20200424204707

6 years ago

0.9.18-20200424193404

6 years ago

0.9.18-20200423151618

6 years ago

0.9.18-20200423213928

6 years ago

0.9.18-20200423213652

6 years ago

0.9.18-20200423161927

6 years ago

0.9.18-20200423214423

6 years ago

0.9.18-20200423142643

6 years ago

0.9.18-20200423153114

6 years ago

0.9.18-20200423214035

6 years ago

0.9.18-20200423205126

6 years ago

0.9.18-20200422222122

6 years ago

0.9.18-20200422172112

6 years ago

0.9.18-20200421190259

6 years ago

0.9.18-20200420191601

6 years ago

0.9.18-20200420182521

6 years ago

0.9.18-20200420181234

6 years ago

0.9.18-20200420131916

6 years ago

0.9.18-20200420143420

6 years ago

0.9.18-20200417224438

6 years ago

0.9.18-20200417221333

6 years ago

0.9.18-20200417202334

6 years ago

0.9.18-20200417195604

6 years ago

0.9.18-20200417151809

6 years ago

0.9.18-20200417151143

6 years ago

0.9.18-20200417134659

6 years ago

0.9.18-20200416182902

6 years ago

0.9.18-20200416161816

6 years ago

0.9.18-20200416135412

6 years ago

0.9.18-20200416135100

6 years ago

0.9.18-20200415185602

6 years ago

0.9.18-20200415170521

6 years ago

0.9.18-20200414205643

6 years ago

0.9.18-20200414190959

6 years ago

0.9.18-20200414182428

6 years ago

0.9.18-20200414182326

6 years ago

0.9.18-20200414151832

6 years ago

0.9.18-20200413203008

6 years ago

0.9.18-20200413203234

6 years ago

0.9.18-20200413203437

6 years ago

0.9.18-20200413212016

6 years ago

0.9.18-20200413130320

6 years ago

0.9.18-20200413175428

6 years ago

0.9.18-20200411004420

6 years ago

0.9.18-20200411004333

6 years ago

0.9.18-20200410205102

6 years ago

0.9.18-20200410193130

6 years ago

0.9.18-20200410195139

6 years ago

0.9.18-20200410192018

6 years ago

0.9.18-20200410190353

6 years ago

0.9.9-20200410182226

6 years ago

0.9.18-20200410165301

6 years ago

0.9.9-20200410181652

6 years ago

0.9.17

6 years ago

0.9.9-20200409215806

6 years ago

0.9.16-20200408194335

6 years ago

0.9.9-20200408192644

6 years ago

0.9.9-20200407210050

6 years ago

0.9.16-20200407163235

6 years ago

0.9.16-20200406210737

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.9.16-20200320212200

6 years ago

0.9.16-20200317173429

6 years ago

0.9.16-20200316193632

6 years ago

0.9.16-20200313190026

6 years ago

0.9.16-20200312192702

6 years ago

0.9.14-20200312165956

6 years ago

0.9.14

6 years ago

0.9.15

6 years ago

0.9.15-20200312192428

6 years ago

0.9.15-20200312183638

6 years ago

0.9.14-20200312183321

6 years ago

0.9.14-20200310212853

6 years ago

0.9.13

6 years ago

0.9.13-20200310212530

6 years ago

0.9.13-20200310155925

6 years ago

0.9.12

6 years ago

0.9.12-20200310155647

6 years ago

0.9.12-20200310153713

6 years ago

0.9.12-20200309204848

6 years ago

0.9.11

6 years ago

0.9.11-20200309195829

6 years ago

0.9.11-20200309204319

6 years ago

0.9.11-20200306213018

6 years ago

0.9.10

6 years ago

0.9.10-20200306212650

6 years ago

0.9.10-20200306194935

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.5.17-20191006160556

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.5.17-20191003184028

6 years ago

0.5.17-20191003183553

6 years ago

0.5.17-20191003181840

6 years ago

0.5.17-20191003155640

6 years ago

0.5.17-20191003135418

6 years ago

0.5.17-20191002141519

6 years ago

0.5.17-20190925192901

6 years ago

0.5.16

6 years ago

0.5.16-20190925192404

6 years ago

0.5.16-20190904192022

6 years ago

0.5.15

6 years ago

0.5.15-20190904191509

6 years ago

0.5.15-20190828184848

6 years ago

0.5.14

6 years ago

0.5.14-20190828184056

6 years ago

0.5.14-20190828162645

6 years ago

0.5.13

6 years ago

0.5.13-20190828155801

6 years ago

0.5.13-20190827214506

6 years ago

0.5.12

6 years ago

0.5.12-20190827212803

6 years ago

0.5.12-20190815205813

6 years ago

0.5.11

6 years ago

0.5.11-20190815204527

6 years ago

0.5.11-20190815203312

6 years ago

0.5.11-20190815203009

6 years ago

0.5.11-20190815195138

6 years ago

0.5.11-20190723143938

7 years ago

0.5.11-20190718191812

7 years ago

0.5.11-20190711160748

7 years ago

0.5.10

7 years ago

0.5.10-20190711160258

7 years ago

0.5.10-20190711143335

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.4.21-20190624210310

7 years ago

0.4.21-20190621195526

7 years ago

0.4.21-20190621190942

7 years ago

0.4.21-20190621152931

7 years ago

0.4.21-20190620184042

7 years ago

0.4.20

7 years ago

0.4.20-20190620183745

7 years ago

0.4.18-20190620183143

7 years ago

0.4.20-20190620170253

7 years ago

0.4.19

7 years ago

0.4.18-20190620164417

7 years ago

0.4.18-20190620160906

7 years ago

0.4.18-20190620150556

7 years ago

0.4.18-20190620094610

7 years ago

0.4.18-20190619060149

7 years ago

0.4.17

7 years ago

0.4.17-20190619055338

7 years ago

0.4.17-20190619052610

7 years ago

0.4.16

7 years ago

0.4.16-20190619052359

7 years ago

0.4.17-20190619052208

7 years ago

0.4.16-20190618212520

7 years ago

0.4.15

7 years ago

0.4.15-20190618212003

7 years ago

0.4.15-20190618210522

7 years ago

0.4.15-20190618210101

7 years ago

0.4.15-20190618203722

7 years ago

0.4.15-20190605133747

7 years ago

0.4.14

7 years ago

0.4.14-20190605132210

7 years ago

0.4.14-20190604195329

7 years ago

0.4.14-20190604185942

7 years ago

0.4.14-20190604184001

7 years ago

0.4.14-20190604133126

7 years ago

0.4.13

7 years ago

0.4.13-20190604085945

7 years ago

0.4.13-20190604084420

7 years ago

0.4.13-20190604084340

7 years ago

0.4.13-20190603233207

7 years ago

0.4.13-20190603193811

7 years ago

0.4.12

7 years ago

0.4.12-20190603193157

7 years ago

0.4.12-20190603191927

7 years ago

0.4.12-20190603183639

7 years ago

0.4.12-20190603181857

7 years ago

0.4.11

7 years ago

0.4.11-20190603180901

7 years ago

0.4.11-20190603180021

7 years ago

0.4.11-20190602122434

7 years ago

0.4.11-20190602122216

7 years ago

0.4.11-20190531215858

7 years ago

0.4.11-20190531200811

7 years ago

0.4.11-20190531191142

7 years ago

0.4.11-20190531170829

7 years ago

0.4.10-20190530222857

7 years ago

0.4.11-20190530181712

7 years ago

0.4.10

7 years ago

0.4.10-20190530180956

7 years ago

0.4.10-20190530145054

7 years ago

0.4.10-20190525092347

7 years ago

0.4.10-20190525092025

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago