ProseMirror is a well-behaved rich semantic content editor based on contentEditable, with support for collaborative editing and custom document schemas.
The ProseMirror library consists of a number of separate modules. This repository just serves as a central issue tracker, and holds a script to help easily check out all the core modules for development.
STOP READING HERE IF YOU'RE SIMPLY USING PROSEMIRROR. YOU CAN INSTALL THE SEPARATE NPM MODULES FOR THAT. THE INSTRUCTIONS BELOW ONLY APPLY WHEN DEVELOPING PROSEMIRROR!
Setting up a dev environment
This will fetch the submodules, install their dependencies, and build them.
bin/pm script in this repository provides functionality for
working with the repositories:
bin/pm buildrebuilds all the modules
bin/pm watchsets up a process that automatically rebuilds the modules when they change
bin/pm statusprints the git status of all submodules
bin/pm commit <args>runs
git commitwith the given arguments in all submodules that have pending changes
bin/pm testruns the (non-browser) tests in all modules
git pushin all modules.
bin/pm grep <pattern>greps through the source code for the modules for the given pattern
(Functionality for managing releases will be added in the future.)
Running the demo
To run the demo in
npm run demo, and go to
localhost:8080. This loads the individual
dist directories, and will
only need a refresh when those are changed.
We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.