Skip to content

A universal react text editor built with prosemirror

License

Notifications You must be signed in to change notification settings

newlinedotco/remirror

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


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 Join the community on Spectrum


remirror

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



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

A gif showing mentions being suggested as the user types with editing supported

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.

Open in Gitpod


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

About

A universal react text editor built with prosemirror

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.5%
  • JavaScript 2.4%
  • Other 0.1%