prosemirror: converting JSON output into HTML

Question

I'm trying to convert ProseMirror's JSON output back to HTML (to save it from one db to another). I am new with ProseMirror and I'm not sure I fully understand the relation between model, state and schema.

Judging from what I have read https://github.com/ProseMirror/prosemirror/issues/455 and https://discuss.prosemirror.net/t/example-of-converting-between-formats-for-the-purpose-of-saving/424,

I should first create a new state based on a basic schema, then use the DOMSerializer and attach the output to a temporary element (then get innerHtml). Does that sound about right? Any help would be greatly appreciated.

score 12 · Answer 1 · answered Sep 14 '18 at 14:16

After some digging, here's how I got this to work:

Create a node using .fromJSON
Make a DOMSerializer based on the schema used by the editor
Pass the node to the serializer

My code is below.

const { schema } = require("prosemirror-schema-basic")
const { Node, DOMSerializer } = require("prosemirror-model")
const jsdom = require("jsdom").JSDOM

let dom = new jsdom('<!DOCTYPE html><div id="content"></div>')
let doc = dom.window.document
let target = doc.querySelector("div")
//Demo JSON output from ProseMirror
let content = {
  "doc": {
    "type": "doc",
    "content": [{
      "type": "paragraph",
      "attrs": {
        "align": "left"
      },
      "content": [{
        "type": "text",
        "text": "My sample text"
      }]
    }]
  },
  "selection": {
    "type": "text",
    "anchor": 16,
    "head": 16
  }
}

let contentNode = Node.fromJSON(schema, content.doc)

DOMSerializer
  .fromSchema(schema)
  .serializeFragment(contentNode.content, {
    "document": doc
  }, target)

console.log(doc.getElementById("content").innerHTML)
//<p>My sample text</p>

kind of a pain for something that should probably be built in — Patrick Michaelsen, Mar 14 '23 at 01:08
might be able to use `` if you want to do it when your editor content updates. See [docs](https://remirror.io/docs/api/react-core#variable-onchangehtml) and [getting started](https://remirror.io/docs/5-min-tutorial/#get-the-current-state) — Patrick Michaelsen, Mar 14 '23 at 01:11

Patrick Michaelsen · Answer 2 · 2023-03-14T02:47:51.127

Note for future readers. If you're using React and you want to get the markdown when the editor's contents update, then here is an example.

import { OnChangeJSON, Remirror } from '@remirror/react';
import { MarkdownExtension } from 'remirror/extensions';
import { useRemirror } from '@remirror/react';
import { RemirrorJSON } from '@remirror/core';


export interface MarkdownControlledEditorProps {
export interface MarkdownControlledEditorProps {
  onChangeJson: (json: RemirrorJSON) => void,
  onChangeMarkdown: (markdown: string) => void,
  initialContent?: string,
}
export const MarkdownControlledEditor = ({
  onChangeJson,
  onChangeMarkdown,
  initialContent,
}: any) => {
  const { manager } = useRemirror({
    selection: 'start',
    extensions: RemirrorExtensionsPreset,
  });

  const _onChangeJson = (json: RemirrorJSON) => {
    onChangeContent({
      json,
      html: manager.store.helpers.getHTML(),
      text: manager.store.helpers.getText(),
      markdown: manager.store.helpers.getMarkdown(),
    });
  }

  return (
    <Remirror
      autoFocus={true}
      autoRender={'start'}
      manager={manager}
      initialContent={initialContent}
    >
      <OnChangeJSON onChange={_onChangeJson}/>
    </Remirror>
  );
};

prosemirror: converting JSON output into HTML

2 Answers2