prosemeteor / prosemirror

Prosemirror integration for Meteor.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CircleCI

#Welcome to ProseMeteor. ProseMeteor is a package integrating ProseMirror and Meteor.js. ProseMeteor is built for Meteor 1.3+


NOTICE

  • This is not production ready. If you'd like to contribute please let us know!
  • Since the ProseMirror API is constantly changing, this project is locked into ProseMirror 0.7.0 for now.

#Goals The primary goal is to provide a package that provides realtime collaborative WYSIWYG editing.

Discussion for the ProseMeteor project will take place on Humon ProseMeteor Wiki

The wiki is readable by everyone but if you would like to contribute please contact funkyeah@gmail.com for an invite.

Developing

Since this project is still in development and the API will likely change, please see the demo application for proper API usage.

To run the demo application, which provides some example documents for a testing playground, use the run_demo.sh script. First give it executable permissions with chmod +x ./run_demo, then run it with ./run_demo.

To reset the demo application (clear its local database), give the ./reset_demo bash script executable permissions as well and run it with ./reset_demo.

File Structure

  • /demo contains an example application
  • /package.js the Meteor atmosphere package file. Defines the prosemeteor:prosemirror package info and main code modules to include
  • /lib/ directory that contains all source code
  • /lib/client/client-main.js the main entry point file for the client. exports client API
  • /lib/server/server-main.js the main entry point file for the server. exports server API
  • /lib/imports/ all JS modules used by the package
  • /lib/imports/startup/ all code for client and server that's run at startup
  • /lib/imports/api/ package api's used internally

About

Prosemirror integration for Meteor.js

License:MIT License


Languages

Language:JavaScript 97.6%Language:Shell 1.1%Language:HTML 1.1%Language:CSS 0.3%