Remirror is a toolkit for building accessible editors which run on the web and desktop.

Status

Remirror is still undergoing heavy development, but is used in production by at least one company. At the moment the focus is on releasing a stable API and while this is ongoing documentation has slipped from being the priority.

Right now the best way to understand the library is to read through the codebase and take a look at how existing editors have been structured. A quick way to get started is to spin up our Next.js example.

Documentation

View our documentation website at https://docs.remirror.org/

• Introduction
• Getting started

Features

• A11y focused and ARIA compatible.
• 3 prebuilt editors, markdown, social and wysiwyg.
• Extensions available for adding your own flavour to your own custom editor editor.
• Zero config support Server Side Rendering (SSR).

Prerequisites

• Typescript >= 3.6
• React >= 16.9
• Yarn >= 1.17

Testing

From the root of this repository run the following to trigger a full typecheck, linting and jest tests.

yarn checks

By default these checks are not run automatically. To enable automatic precommit and prepush hooks use the following command:

yarn start:checks

To stop per-commit / per-push checks run:

yarn stop:checks

Built With

• Typescript
• React
• Prosemirror
• Theme UI

Contributing

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests.

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository.

Currently all versions within the repo are locked and this will continue until v1.0.0 is. At this point versions will be updated independently.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributors

Ifiok Jr. 📖 💻 💡 ⚠️ 🚧	Benjie Gillam 📖 🐛 💡 💻	Anton Rieder 📖	Aaron Greenlee 📖 💻	Charley Bodkin 💻 📖	ocavue 💻	Hugh Boylan 💻
William M. Riley 💻 🐛