• Stars
    star
    167
  • Rank 218,510 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 8 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The ProseMirror website

Prosemirror.net

These are the sources for https://prosemirror.net

This currently contains a front-page, the examples (including server-side code to support the collaborative demo), the guide, and the scripts to build the reference docs.

Installation

Install Node.js.

Install the module's dependencies:

npm install

Build the documentation and all the demos' JavaScript source

make

That will populate the public/ directory with an instance of the website. You could point a webserver at it to try it out.

To work on the demos, or to experiment with the collaborative demo, it is a good idea to use the dev server:

npm run devserver -- --port 8888

That will get you a server at localhost:8888 that serves the files in public/, along with the collaborative editing backend, and updates the demo pages to use moduleserve so that you can run the demos directly from the source files, rather than using the bundled code. You can now edit them and see the changes with a single refresh. (Though the server-side collaborative code still needs a server refresh to update.)

Note that this is not secure (it provides file system access of HTTP) and not fast (the browser will fetch each module individually), and should only be used for development, on your local machine, bound to localhost.

More Repositories

1

prosemirror

The ProseMirror WYSIWYM editor
JavaScript
7,144
star
2

prosemirror-view

ProseMirror's view component
TypeScript
1,478
star
3

prosemirror-markdown

ProseMirror Markdown integration
TypeScript
292
star
4

prosemirror-tables

Table module for ProseMirror
TypeScript
231
star
5

prosemirror-model

ProseMirror's document model
TypeScript
231
star
6

prosemirror-state

ProseMirror editor state
TypeScript
159
star
7

prosemirror-example-setup

An example of how to set up a ProseMirror editor
TypeScript
127
star
8

prosemirror-transform

ProseMirror document transformations
TypeScript
113
star
9

prosemirror-collab

Collaborative editing for ProseMirror
TypeScript
95
star
10

prosemirror-commands

Editing commands for ProseMirror
TypeScript
84
star
11

prosemirror-changeset

Distills a series of editing steps into deleted and added ranges
TypeScript
65
star
12

prosemirror-schema-basic

Basic schema elements for ProseMirror
TypeScript
55
star
13

prosemirror-menu

Simple menu elements for ProseMirror
TypeScript
46
star
14

prosemirror-history

Undo history for ProseMirror
TypeScript
37
star
15

prosemirror-dropcursor

A drop cursor plugin for ProseMirror
TypeScript
36
star
16

rfcs

ProseMirror RFCs
25
star
17

prosemirror-schema-list

List-related schema elements and commands for ProseMirror
TypeScript
25
star
18

prosemirror-gapcursor

Plugin for cursors at normally impossible-to-reach positions
TypeScript
23
star
19

prosemirror-inputrules

Automatic transforms on text input for ProseMirror
TypeScript
23
star
20

prosemirror-keymap

Keymap plugin for ProseMirror
TypeScript
19
star
21

prosemirror-test-builder

Document building utilities for writing tests
TypeScript
15
star
22

prosemirror-schema-table

Table-related schema elements and commands for ProseMirror
JavaScript
6
star
23

buildhelper

Build and test scripts for ProseMirror packages
JavaScript
3
star