prosemirror-to-html-sync

0.0.1 • Public • Published

ProseToHTML

A library for converting ProseMirror Editor content to plain HTML.

Installation

npm i prosemirror-to-html-sync

Usage

const ProseToHTML = require("ProseToHTML");
 
// Pass in the JSON data received from the ProseMirror Editor
ProseToHTML.toHTML(proseEditorData));

A ProseToHTML instance can take in following properties:

  • types: List of type handlers
  • marks: List of mark handlers
  • verbose: Boolean, debug output (true or false)

and has access to the following functions:

- toHTML(object):

 toHTML(proseEditorOutput)
 returns: html (string)

- initProseMark(string, function):

initProseMark("italic", (value) => {
    return `<i>${value}</i>`;
})

- initProseEntity(string, function):

initProseEntity("paragraph", function (config, proseToHTML) {
    return "<p>" + proseModule.renderEntityChildren(config) + "</p>";
})

It is important to note that initProseEntity() or initProseMark() overwrite default values, thus easy to adapt!

Test

To test it, just run the test script.

License

MIT.

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

      npm i prosemirror-to-html-sync

      Weekly Downloads

      0

      Version

      0.0.1

      License

      MIT

      Unpacked Size

      8.68 kB

      Total Files

      29

      Last publish

      Collaborators

      • bradlc