The ProseMirror WYSIWYM editor
Перейти к файлу
Marijn Haverbeke 2765b6c085 Change approach to unwrapping lift to avoid violating document contraints 2016-05-24 13:41:51 +02:00
demo Read selection from DOM after domchange 2016-04-26 12:31:17 +02:00
script Add an AUTHORS file 2016-03-10 11:08:16 +01:00
src Change approach to unwrapping lift to avoid violating document contraints 2016-05-24 13:41:51 +02:00
.babelrc Upgrade to babel 6 2016-01-11 13:38:56 +01:00
.editorconfig Adds .editorconfig 2016-01-22 15:08:04 +01:00
.gitignore Use moduleserve for the demo and browser tests 2016-01-21 17:04:36 +01:00
.npmignore Leave /demo out of npm packages 2016-01-28 10:19:14 +01:00
.tern-project [tern-project] Enable es_module plugin 2015-09-02 11:31:26 +02:00
AUTHORS Mark release 0.6.1 2016-04-15 09:38:34 +02:00
CHANGELOG.md Mark release 0.7.0 2016-05-19 22:50:21 +02:00
CONTRIBUTING.md Describe how to run tests in contributing docs. 2016-03-04 16:22:59 +01:00
LICENSE Update license year range to 2016 2016-01-18 11:43:39 +01:00
Makefile [makefile] Fix evaluation order and dir creation 2015-10-16 13:55:47 +02:00
README.md Add note in README that demo isn't part of NPM package 2016-04-25 11:16:30 +02:00
package.json Mark release 0.7.0 2016-05-19 22:50:21 +02:00

README.md

ProseMirror

Join the chat at https://gitter.im/ProseMirror/prosemirror

This is a well-behaved rich semantic content editor based on contentEditable, with support for collaborative editing and customizable document models.

The project page has a number of demos and the documentation.

NOTE: This project is in BETA stage. It isn't thoroughly tested, and the API might still change across 0.x releases. You are welcome to use it, but don't expect it to be very stable yet.

This code is released under an MIT license. There's a forum for general discussion and support requests, and the Github bug tracker is the place to report issues.

Documentation can be found on the website.

Run the demo

Install Node.js.

Clone the git repository. (The NPM package does not come with the demo files.)

Inside the project directory, install the project's node dependencies

npm install

Make sure you have an up-to-date dist/ dir:

npm run dist
# or, to keep compiling as files are changed
npm run dist-watch
# or, to mount a virtual ES6-compiling filesystem
# (might not work on non-Linux OSs)
npm run distfs

Start the demo server (serves demo files, resolves modules):

npm run demo

Open http://localhost:8080/ in your browser