Skip to content
A universal react text editor built with prosemirror
TypeScript JavaScript Other
Branch: canary
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.changeset ci(changeset): generate PR with changelog & version updates (#240) Feb 20, 2020
.github fix: update to new organisation url (#212) Feb 5, 2020
.vscode style: separate Prettier from ESLint (#198) Jan 17, 2020
@remirror ci(changeset): generate PR with changelog & version updates (#240) Feb 20, 2020
docs ci(changeset): generate PR with changelog & version updates (#219) Feb 20, 2020
e2e ci(changeset): generate PR with changelog & version updates (#219) Feb 20, 2020
examples ci(changeset): generate PR with changelog & version updates (#219) Feb 20, 2020
packages ci(changeset): generate PR with changelog & version updates (#219) Feb 20, 2020
support feat(core): improve keybinding composition (#234) Feb 19, 2020
.all-contributorsrc docs: add hboylan as a contributor (#214) Feb 6, 2020
.artifactignore ci: preserve build across jobs (#161) Sep 26, 2019
.eslintignore style: separate Prettier from ESLint (#198) Jan 17, 2020
.eslintrc.js style: separate Prettier from ESLint (#198) Jan 17, 2020
.gitattributes ci: fix broken integration tests due to lfs Jun 20, 2019
.gitignore chore: remove cc-reporter Jan 11, 2020
.gitpod.yml ci: preserve build across jobs (#161) Sep 26, 2019
.size-limit.json chore: update configs with `yarn generate:json` Jan 10, 2020
.yarnrc feat: add some small changes and a new next.js package Jun 11, 2019
LICENSE feat: add twitter ui clone as example Mar 3, 2019
babel.config.js refactor: @remirror/extension-mentions Jul 9, 2019
changelog.md fix: update to new organisation url (#212) Feb 5, 2020
globals.d.ts feat: jest-prosemirror snapshot serializer Sep 25, 2019
jest-puppeteer.config.js feat: complete refactor of e2e tests Jul 21, 2019
netlify.toml docs: move from docz to gatsby Jul 26, 2019
package.json fix: remove custom browserslist configuration (#239) Feb 20, 2020
readme.md docs: add hboylan as a contributor (#214) Feb 6, 2020
tsconfig.json fix: remove skipLibCheck from tsconfig Jan 12, 2020
tsconfig.lint.json style: fix broken linting Jan 12, 2020
tsconfig.prod.json chore: update configs with `yarn generate:json` Jan 10, 2020
yarn.lock docs: resolve broken `build:docs` (#235) Feb 20, 2020

readme.md


remirror



Azure DevOps builds GitHub Actions CI GitHub commit activity GitHub last commit GitHub issues GitHub pull requests GitHub stars LICENSE Netlify Status Join the community on Spectrum


remirror

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/


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


Contributors


Ifiok Jr.

📖 💻 💡 ⚠️ 🚧

Benjie Gillam

📖 🐛 💡 💻

Anton Rieder

📖

Aaron Greenlee

📖 💻

Charley Bodkin

💻 📖

ocavue

💻

Hugh Boylan

💻
You can’t perform that action at this time.