Highlighter

A complete rich text editor based on Slate framework with extended 'Highlighting' functionality.

Packages

Highlighter is a monorepo managed with Lerna. It is separated into two packages, which are:

Package	Description	Status
highlighter-component	Rich text editor with out of box modules and toolbar components	Substantially Complete
highlighter-core	Provides main highlighter functionalities	In Progress

highlighter-component built-in modules

Module Name	Module Type	Toolbar Type	Status
Paragraph	Element	Block Toolbar	Supported
List	Element	Block Toolbar	Supported
Heading	Element	Block Toolbar	Supported
Divider	Element	Block Toolbar	Unsupported
Link	Element	Float Toolbar	Supported
Bold	Mark	Float Toolbar	Supported
Italic	Mark	Float Toolbar	Supported
Underline	Mark	Float Toolbar	Supported

Demo

Check out the demo by the following setup instructions:

Clone the repo

git clone git@github.com:Yan-Boogie/highlighter.git

Install package dependencies

yarn

Build packages

yarn build:rollup

Run Next project in split terminal

yarn start

Open website

yarn open

TODO List

• click-away feature
• link element feature
• Divider element feature