/remirror

A universal react text editor built with prosemirror

Primary LanguageTypeScriptMIT LicenseMIT


remirror



Azure DevOps builds Travis (.com) GitHub commit activity GitHub last commit GitHub issues GitHub pull requests GitHub stars GitHub tag (latest SemVer) LICENSE Netlify Status


Remirror is your toolkit for building world-class text-editors which run on the web, mobile and desktop.



Features

  • Full support for Server Side Rendering (SSR) with zero config.
  • Top quality prebuilt editors for immediate use in your next application.
  • Almost 30 ready-made extensions for adding your own flavour and functionality to build your dream editor.
  • CSS-in-JS support (can be switched off).

Prerequisites

  • Typescript >= 3.5
  • React >= 16.8
  • Yarn >= 1.13

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

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.

License

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