html-to-prosemirror

KO | EN

gitlite — search

#python #java #nodejs #python3 #android #css #javascript #json #golang #react #natural-language-processing #nlp

html-to-prosemirror

★ 71 Open GitHub ↗

Takes HTML and outputs ProseMirror compatible JSON.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> 🚨 We’ve done a rewrite that you probably want to check out: [ueberdosis/tiptap-php](https://github.com/ueberdosis/tiptap-php)

# HTML to ProseMirror

[![](https://img.shields.io/packagist/v/ueberdosis/html-to-prosemirror.svg)](https://packagist.org/packages/ueberdosis/html-to-prosemirror)
[![Integrate](https://github.com/ueberdosis/html-to-prosemirror/workflows/Integrate/badge.svg?branch=main)](https://github.com/ueberdosis/html-to-prosemirror/actions)
[![](https://img.shields.io/packagist/dt/ueberdosis/html-to-prosemirror.svg)](https://packagist.org/packages/ueberdosis/html-to-prosemirror)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)

Takes HTML and outputs ProseMirror compatible JSON.

## Installation
```bash
composer require ueberdosis/html-to-prosemirror
```

## Usage
```php
(new \HtmlToProseMirror\Renderer)->render('<p>Example Text</p>')
```

## Output
```json
{
    "type": "doc",
    "content": [
        {
            "type": "paragraph",
            "content": [
                {
                    "type": "text",
                    "text": "Example Text"
                }
            ]
        }
    ]
}
```

## Supported nodes
- [Blockquote](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/Blockquote.php)
- [BulletList](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/BulletList.php)
- [CodeBlock](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/CodeBlock.php)
- [HardBreak](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/HardBreak.php)
- [Heading](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/Heading.php)
- [Image](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/Image.php)
- [ListItem](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/ListItem.php)
- [OrderedList](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/OrderedList.php)
- [Paragraph](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/Paragraph.php)
- [Table](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/Table.php)
- [TableCell](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/TableCell.php)
- [TableHeader](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/TableHeader.php)
- [TableRow](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/TableRow.php)
- [User](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Nodes/User.php)

## Supported marks
- [Bold](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Bold.php)
- [Code](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Code.php)
- [Italic](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Italic.php)
- [Link](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Link.php)
- [Strike](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Strike.php)
- [Subscript](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Subscript.php)
- [Superscript](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Superscript.php)
- [Underline](https://github.com/ueberdosis/html-to-prosemirror/blob/main/src/Marks/Underline.php)

## Custom nodes
Define your custom nodes as PHP classes:
```php
<?php

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

And register them:
```php
$renderer->addNode(CustomNode::class);
```

Or overwrite the enabled nodes:
```php
$renderer->withNodes([
    CustomNode::class,
]);
```

Or overwrite the enabled marks:
```php
$renderer->withMarks([
    Bold::class,
]);
```

Or replace just one mark or node:

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

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

## Contributing
Pull Requests are welcome.

## Credits
- [Hans Pagel](https://github.com/hanspagel)
- [localheinz](https://github.com/localheinz)
- [sauerbraten](https://github.com/sauerbraten)
- [WiebkeVog](https://github.com/WiebkeVog)
- [pa-bouly](https://github.com/pa-bouly)
- [All Contributors](../../contributors)

## Related packages
- [tiptap](https://github.com/ueberdosis/tiptap) by @ueberdosis
- [html-to-prosemirror-js](https://github.com/enVolt/html-to-prosemirror) by @enVolt

## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

html-to-prosemirror

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README