@cristata/prosemirror-to-html-js

    2.2.2 • Public • Published

    ProseMirror to HTML (JS)

    (This package is based on prosemirror-to-html, which was originally written for PHP.)

    Takes ProseMirror JSON and outputs HTML.

    Installation

    npm install @cristata/prosemirror-to-html-js --save

    Usage

    const Renderer = require('@cristata/prosemirror-to-html-js').Renderer;
    
    const renderer = new Renderer();
    
    console.log(
      renderer.render({
        type: 'doc',
        content: [
          {
            type: 'paragraph',
            content: [
              {
                type: 'text',
                text: 'Example Paragraph',
              },
            ],
          },
        ],
      })
    ); // `<p>Example Text</p>`

    Supported Nodes

    • Blockquote
    • BulletList
    • CodeBlock
    • Heading
    • ListItem
    • OrderedList
    • Paragraph

    Supported Marks

    • Bold
    • Code
    • Italic
    • Link

    Custom Nodes

    Define your node as a class -

    const Node = require('prosemirror-to-html').Node;
    
    class CustomNode extends Node {
      matching() {
        return this.node.type === 'custom_node';
      }
    
      tag() {
        return ['cnode', this.node.attrs, 0];
      }
    }

    Feed it to renderer instance -

    renderer.addNode(CustomNode);

    Install

    npm i @cristata/prosemirror-to-html-js

    DownloadsWeekly Downloads

    4

    Version

    2.2.2

    License

    ISC

    Unpacked Size

    29.2 kB

    Total Files

    35

    Last publish

    Collaborators

    • jackbuehner