/substance

A JavaScript library for web-based content editing.

Primary LanguageJavaScriptMIT LicenseMIT

Substance Build Status

Substance is a JavaScript library for web-based content editing. It provides building blocks for realizing custom text editors and web-based publishing systems.

Check the project website, the examples and the API documentation.

Features

Features State
Custom document schemas ✓
Custom converters (XML, HTML, etc.) ✓
Custom HTML Rendering ✓
Annotations that can span over multiple nodes ✓
Annotations can hold information (e.g. a comment) ✓
Incremental document updates (undoable operations) ✓
Transformations for document manipulation ✓
Custom editing toolbars ✓
Commands for controlling the editor ✓
Key bindings Beta 3
I18N support ✓
Realtime collaboration Beta 3
Full Unicode support Beta 3
Plugins Beta 3
Persistence API for documents Beta 4 
                                                                        |

UI Components | TextPropertyEditor for editing annotated text | ✓ ContainerEditor for in-flow-editing | ✓ Scrollable ContentPanel with Support for highlights | ✓ Customizable Toolbar | ✓ Interactive Scrollbar | ✓ Interactive TOCPanel | ✓ | Predefined content types | Paragraph | ✓ Heading | ✓ Blockquote | ✓ Codeblock | ✓ Imgage | ✓ Embed (image, video, tweet etc.) | ✓ List | Beta 3 Table | Beta 3 Figure (including upload) | Beta 4 | Predefined annotation types | Strong | ✓ Emphasis | ✓ Link | ✓ Subscript | ✓ Superscript | ✓ Code | ✓ Comment | Beta 3

Development

Install the dev dependencies.

npm install

Run the dev server.

npm start

Navigate to http://localhost:4201/docs for the docs and http://localhost:4201/test for the test suite.

To run the test-suite headless (using Phantom.js)

$ npm test

To create a test coverate report:

$ npm run coverage

The report is stored in the coverage folder.

To bundle the docs into a distribution:

$ npm run doc

Roadmap

Beta 3

ETA: January 2016

  • Automatically generated performance report
  • Table node
  • Editing of lists
  • Key bindings
  • Plugins
  • Realtime collaboration
  • Improved Unicode support
  • Improved stability, documentation and tests

Beta 4

  • Modules for server-side integration
    • Persistence API for documents
    • Figure upload
  • Server-side realtime collaboration infrastructure
  • Full-stack platform example

1.0 Final

  • Complete documentation
  • Full test coverage
  • Final versions of API's