Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ProseMirror/prosemirror

The ProseMirror WYSIWYM editor
https://github.com/ProseMirror/prosemirror

Last synced: 9 days ago
JSON representation

The ProseMirror WYSIWYM editor

Awesome Lists containing this project

README 

        
# prosemirror



[ [**WEBSITE**](https://prosemirror.net) | [**ISSUES**](https://github.com/prosemirror/prosemirror/issues) | [**FORUM**](https://discuss.prosemirror.net) ]



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](https://github.com/prosemirror/). This repository just

serves as a central issue tracker, and holds a script to help easily

check out all the core modules for development.



The [project page](https://prosemirror.net) has more information, a

number of [examples](https://prosemirror.net/examples/) and the

[documentation](https://prosemirror.net/docs/).



This code is released under an

[MIT license](https://github.com/prosemirror/prosemirror/tree/master/LICENSE).

There's a [forum](http://discuss.prosemirror.net) for general

discussion and support requests, and the

[Github bug tracker](https://github.com/prosemirror/prosemirror/issues)

is the place to report issues.



**STOP READING HERE IF YOU'RE SIMPLY _USING_ PROSEMIRROR. YOU CAN

INSTALL THE SEPARATE [NPM

MODULES](https://www.npmjs.com/search?q=prosemirror-) FOR THAT. THE

INSTRUCTIONS BELOW ONLY APPLY WHEN _DEVELOPING_ PROSEMIRROR!**



## Setting up a dev environment



Clone this repository, and make sure you have

[node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/) (due

to a string of issues with NPM 5, NPM is not currently supported)

installed. Next, from the cloned directory run:



    bin/pm install



This will fetch the submodules, install their dependencies, and build

them.



The `bin/pm` script in this repository provides functionality for

working with the repositories:



 * `bin/pm build` rebuilds all the modules



 * `bin/pm watch` sets up a process that automatically rebuilds the

   modules when they change



 * `bin/pm status` prints the git status of all submodules



 * `bin/pm commit ` runs `git commit` with the given arguments

   in all submodules that have pending changes



 * `bin/pm test` runs the (non-browser) tests in all modules



 * `bin/pm push` runs `git push` in all modules



 * `bin/pm grep ` greps through the source code for the

   modules for the given pattern



 * `bin/pm dev-start` starts a server that rebuilds the packages

   whenever their sources change, and exposes the demo (`demo/*`)

   under a webserver on port 8080



(Functionality for managing releases will be added in the future.)



## Community



Development of ProseMirror happens in the various repositories exposed

under the [ProseMirror](https://github.com/ProseMirror) organization

on GitHub. Bugs for core packages are tracked in the [bug

tracker](https://github.com/prosemirror/prosemirror/issues) for the

meta repository.



We aim to be an inclusive, welcoming community. To make that explicit,

we have a [code of

conduct](http://contributor-covenant.org/version/1/1/0/) that applies

to communication around the project.