README

🚨 We’ve done a rewrite that you probably want to check out: ueberdosis/tiptap-php

HTML to ProseMirror

Takes HTML and outputs ProseMirror compatible JSON.

Installation

composer require ueberdosis/html-to-prosemirror

Usage

(new \HtmlToProseMirror\Renderer)->render('<p>Example Text</p>')

Output

{
    "type": "doc",
    "content": [
        {
            "type": "paragraph",
            "content": [
                {
                    "type": "text",
                    "text": "Example Text"
                }
            ]
        }
    ]
}

Supported nodes

• Blockquote
• BulletList
• CodeBlock
• HardBreak
• Heading
• Image
• ListItem
• OrderedList
• Paragraph
• Table
• TableCell
• TableHeader
• TableRow
• User

Supported marks

• Bold
• Code
• Italic
• Link
• Strike
• Subscript
• Superscript
• Underline

Custom nodes

Define your custom nodes as PHP classes:

<?php

class CustomNode extends \HtmlToProseMirror\Nodes\Node
{
    protected $markType = 'custom';
    protected $tagName = 'marquee';
}

And register them:

$renderer->addNode(CustomNode::class);

Or overwrite the enabled nodes:

$renderer->withNodes([
    CustomNode::class,
]);

Or overwrite the enabled marks:

$renderer->withMarks([
    Bold::class,
]);

Or replace just one mark or node:

$renderer->replaceNode(
    CodeBlock::class, CustomCodeBlock::class
);

$renderer->replaceMark(
    Bold::class, CustomBold::class
);

Contributing

Pull Requests are welcome.

Credits

• Hans Pagel
• localheinz
• sauerbraten
• WiebkeVog
• pa-bouly
• All Contributors

Related packages

• tiptap by @ueberdosis
• html-to-prosemirror-js by @enVolt

License

The MIT License (MIT). Please see License File for more information.