npm - @blocknote/core - Versions diffs - 0.9.6 → 0.10.0 - Mend

@blocknote/core 0.9.6 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (367) hide show

package/src/api/exporters/html/__snapshots__/paste/parse-nested-lists.json ADDED Viewed

@@ -0,0 +1,70 @@
+[
+  {
+    "id": "1",
+    "type": "bulletListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Bullet List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "2",
+    "type": "bulletListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Nested Bullet List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "3",
+    "type": "bulletListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Nested Bullet List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "4",
+    "type": "bulletListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Bullet List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  }
+]

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/basic/external.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p class="bn-inline-content simple-custom-paragraph" data-editable="">Custom Paragraph</p>

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/basic/internal.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="1"><div class="bn-block" data-node-type="blockContainer" data-id="1"><div class="bn-block-content" data-content-type="simpleCustomParagraph"><p class="bn-inline-content simple-custom-paragraph" data-editable="">Custom Paragraph</p></div></div></div></div>

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/nested/external.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p class="bn-inline-content simple-custom-paragraph" data-editable="">Custom Paragraph</p><p class="bn-inline-content simple-custom-paragraph" data-editable="">Nested Custom Paragraph 1</p><p class="bn-inline-content simple-custom-paragraph" data-editable="">Nested Custom Paragraph 2</p>

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/nested/internal.html ADDED Viewed

@@ -0,0 +1 @@

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/styled/external.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p class="bn-inline-content simple-custom-paragraph" data-editable="">Plain <span data-text-color="red">Red Text </span><span data-background-color="blue">Blue Background </span><span data-text-color="red"><span data-background-color="blue">Mixed Colors</span></span></p>

package/src/api/exporters/html/__snapshots__/simpleCustomParagraph/styled/internal.html ADDED Viewed

@@ -0,0 +1 @@

+ <div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="1" data-text-color="orange" data-background-color="pink"><div class="bn-block" data-node-type="blockContainer" data-id="1" data-text-color="orange" data-background-color="pink"><div class="bn-block-content" data-content-type="simpleCustomParagraph" data-text-alignment="center"><p class="bn-inline-content simple-custom-paragraph" data-editable="">Plain <span data-text-color="red">Red Text </span><span data-background-color="blue">Blue Background </span><span data-text-color="red"><span data-background-color="blue">Mixed Colors</span></span></p></div></div></div></div>

package/src/api/exporters/html/__snapshots__/simpleImage/basic/external.html ADDED Viewed

@@ -0,0 +1 @@

package/src/api/exporters/html/__snapshots__/simpleImage/basic/internal.html ADDED Viewed

@@ -0,0 +1 @@

package/src/api/exporters/html/__snapshots__/simpleImage/button/external.html ADDED Viewed

@@ -0,0 +1 @@

+ <div class="bn-image-block-content-wrapper" style="align-items: flex-start;"><div class="bn-add-image-button"><div class="bn-add-image-button-icon"></div><p class="bn-add-image-button-text"></p></div><div class="bn-image-and-caption-wrapper" style="display: none;"><div class="bn-image-wrapper" style="display: none;"><img class="bn-image" src="" alt="placeholder" draggable="false" style="width: 0px;"><div class="bn-image-resize-handle" style="left: 4px;"></div><div class="bn-image-resize-handle" style="right: 4px;"></div></div><p class="bn-image-caption"></p></div></div>

package/src/api/exporters/html/__snapshots__/simpleImage/button/internal.html ADDED Viewed

@@ -0,0 +1 @@

package/src/api/exporters/html/__snapshots__/simpleImage/nested/external.html ADDED Viewed

@@ -0,0 +1 @@

+ <div class="bn-image-block-content-wrapper" style="align-items: flex-start;"><div class="bn-add-image-button" style="display: none;"><div class="bn-add-image-button-icon"></div><p class="bn-add-image-button-text"></p></div><div class="bn-image-and-caption-wrapper"><div class="bn-image-wrapper"><img class="bn-image" src="exampleURL" alt="placeholder" draggable="false" style="width: 0px;"><div class="bn-image-resize-handle" style="left: 4px;"></div><div class="bn-image-resize-handle" style="right: 4px;"></div></div><p class="bn-image-caption" style="padding: 4px;"></p></div></div><div class="bn-image-block-content-wrapper" style="align-items: flex-start;"><div class="bn-add-image-button" style="display: none;"><div class="bn-add-image-button-icon"></div><p class="bn-add-image-button-text"></p></div><div class="bn-image-and-caption-wrapper"><div class="bn-image-wrapper"><img class="bn-image" src="exampleURL" alt="placeholder" draggable="false" style="width: 0px;"><div class="bn-image-resize-handle" style="left: 4px;"></div><div class="bn-image-resize-handle" style="right: 4px;"></div></div><p class="bn-image-caption" style="padding: 4px;"></p></div></div>

package/src/api/exporters/html/__snapshots__/simpleImage/nested/internal.html ADDED Viewed

@@ -0,0 +1 @@

+ <div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="1"><div class="bn-block" data-node-type="blockContainer" data-id="1"><div class="bn-block-content" data-content-type="simpleImage" data-url="exampleURL" data-caption="Caption" data-width="256"><div class="bn-image-block-content-wrapper" style="align-items: flex-start;"><div class="bn-add-image-button" style="display: none;"><div class="bn-add-image-button-icon"></div><p class="bn-add-image-button-text"></p></div><div class="bn-image-and-caption-wrapper"><div class="bn-image-wrapper"><img class="bn-image" src="exampleURL" alt="placeholder" draggable="false" style="width: 0px;"><div class="bn-image-resize-handle" style="left: 4px;"></div><div class="bn-image-resize-handle" style="right: 4px;"></div></div><p class="bn-image-caption" style="padding: 4px;"></p></div></div></div><div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="2"><div class="bn-block" data-node-type="blockContainer" data-id="2"><div class="bn-block-content" data-content-type="simpleImage" data-url="exampleURL" data-caption="Caption" data-width="256"><div class="bn-image-block-content-wrapper" style="align-items: flex-start;"><div class="bn-add-image-button" style="display: none;"><div class="bn-add-image-button-icon"></div><p class="bn-add-image-button-text"></p></div><div class="bn-image-and-caption-wrapper"><div class="bn-image-wrapper"><img class="bn-image" src="exampleURL" alt="placeholder" draggable="false" style="width: 0px;"><div class="bn-image-resize-handle" style="left: 4px;"></div><div class="bn-image-resize-handle" style="right: 4px;"></div></div><p class="bn-image-caption" style="padding: 4px;"></p></div></div></div></div></div></div></div></div></div>

package/src/api/exporters/html/__snapshots__/small/basic/external.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p class="bn-inline-content"><small data-style-type="small" data-editable="">This is a small text</small></p>

package/src/api/exporters/html/__snapshots__/small/basic/internal.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="1"><div class="bn-block" data-node-type="blockContainer" data-id="1"><div class="bn-block-content" data-content-type="paragraph"><p class="bn-inline-content"><small data-style-type="small" data-editable="">This is a small text</small></p></div></div></div></div>

package/src/api/exporters/html/__snapshots__/tag/basic/external.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p class="bn-inline-content">I love <span data-inline-content-type="tag">#<span data-editable="">BlockNote</span></span></p>

package/src/api/exporters/html/__snapshots__/tag/basic/internal.html ADDED Viewed

@@ -0,0 +1 @@

package/src/api/exporters/html/externalHTMLExporter.ts ADDED Viewed

@@ -0,0 +1,98 @@
+import { DOMSerializer, Fragment, Node, Schema } from "prosemirror-model";
+import rehypeParse from "rehype-parse";
+import rehypeStringify from "rehype-stringify";
+import { unified } from "unified";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  PartialBlock,
+  StyleSchema,
+} from "../../../schema";
+import { blockToNode } from "../../nodeConversions/nodeConversions";
+import {
+  serializeNodeInner,
+  serializeProseMirrorFragment,
+} from "./util/sharedHTMLConversion";
+import { simplifyBlocks } from "./util/simplifyBlocksRehypePlugin";
+// Used to export BlockNote blocks and ProseMirror nodes to HTML for use outside
+// the editor. Blocks are exported using the `toExternalHTML` method in their
+// `blockSpec`, or `toInternalHTML` if `toExternalHTML` is not defined.
+//
+// The HTML created by this serializer is different to what's rendered by the
+// editor to the DOM. This also means that data is likely to be lost when
+// converting back to original blocks. The differences in the output HTML are:
+// 1. It doesn't include the `blockGroup` and `blockContainer` wrappers meaning
+// that nesting is not preserved for non-list-item blocks.
+// 2. `li` items in the output HTML are wrapped in `ul` or `ol` elements.
+// 3. While nesting for list items is preserved, other types of blocks nested
+// inside a list are un-nested and a new list is created after them.
+// 4. The HTML is wrapped in a single `div` element.
+//
+// The serializer has 2 main methods:
+// `exportBlocks`: Exports an array of blocks to HTML.
+// `exportFragment`: Exports a ProseMirror fragment to HTML. This is mostly
+// useful if you want to export a selection which may not start/end at the
+// start/end of a block.
+export interface ExternalHTMLExporter<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+> {
+  exportBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;
+  exportProseMirrorFragment: (fragment: Fragment) => string;
+}
+export const createExternalHTMLExporter = <
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  schema: Schema,
+  editor: BlockNoteEditor<BSchema, I, S>
+): ExternalHTMLExporter<BSchema, I, S> => {
+  const serializer = DOMSerializer.fromSchema(schema) as DOMSerializer & {
+    serializeNodeInner: (
+      node: Node,
+      options: { document?: Document }
+    ) => HTMLElement;
+    // TODO: Should not be async, but is since we're using a rehype plugin to
+    //  convert internal HTML to external HTML.
+    exportProseMirrorFragment: (fragment: Fragment) => string;
+    exportBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;
+  };
+  serializer.serializeNodeInner = (
+    node: Node,
+    options: { document?: Document }
+  ) => serializeNodeInner(node, options, serializer, editor, true);
+  // Like the `internalHTMLSerializer`, also uses `serializeProseMirrorFragment`
+  // but additionally runs it through the `simplifyBlocks` rehype plugin to
+  // convert the internal HTML to external.
+  serializer.exportProseMirrorFragment = (fragment) => {
+    const externalHTML = unified()
+      .use(rehypeParse, { fragment: true })
+      .use(simplifyBlocks, {
+        orderedListItemBlockTypes: new Set<string>(["numberedListItem"]),
+        unorderedListItemBlockTypes: new Set<string>(["bulletListItem"]),
+      })
+      .use(rehypeStringify)
+      .processSync(serializeProseMirrorFragment(fragment, serializer));
+    return externalHTML.value as string;
+  };
+  serializer.exportBlocks = (blocks: PartialBlock<BSchema, I, S>[]) => {
+    const nodes = blocks.map((block) =>
+      blockToNode(block, schema, editor.styleSchema)
+    );
+    const blockGroup = schema.nodes["blockGroup"].create(null, nodes);
+    return serializer.exportProseMirrorFragment(Fragment.from(blockGroup));
+  };
+  return serializer;
+};

package/src/api/exporters/html/htmlConversion.test.ts ADDED Viewed

@@ -0,0 +1,100 @@
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import { addIdsToBlocks, partialBlocksToBlocksForTesting } from "../../..";
+import { BlockSchema, PartialBlock } from "../../../schema/blocks/types";
+import { InlineContentSchema } from "../../../schema/inlineContent/types";
+import { StyleSchema } from "../../../schema/styles/types";
+import { customBlocksTestCases } from "../../testUtil/cases/customBlocks";
+import { customInlineContentTestCases } from "../../testUtil/cases/customInlineContent";
+import { customStylesTestCases } from "../../testUtil/cases/customStyles";
+import { defaultSchemaTestCases } from "../../testUtil/cases/defaultSchema";
+import { createExternalHTMLExporter } from "./externalHTMLExporter";
+import { createInternalHTMLSerializer } from "./internalHTMLSerializer";
+async function convertToHTMLAndCompareSnapshots<
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  blocks: PartialBlock<B, I, S>[],
+  snapshotDirectory: string,
+  snapshotName: string
+) {
+  addIdsToBlocks(blocks);
+  const serializer = createInternalHTMLSerializer(
+    editor._tiptapEditor.schema,
+    editor
+  );
+  const internalHTML = serializer.serializeBlocks(blocks);
+  const internalHTMLSnapshotPath =
+    "./__snapshots__/" +
+    snapshotDirectory +
+    "/" +
+    snapshotName +
+    "/internal.html";
+  expect(internalHTML).toMatchFileSnapshot(internalHTMLSnapshotPath);
+  // turn the internalHTML back into blocks, and make sure no data was lost
+  const fullBlocks = partialBlocksToBlocksForTesting(
+    editor.blockSchema,
+    blocks
+  );
+  const parsed = await editor.tryParseHTMLToBlocks(internalHTML);
+  expect(parsed).toStrictEqual(fullBlocks);
+  // Create the "external" HTML, which is a cleaned up HTML representation, but lossy
+  const exporter = createExternalHTMLExporter(
+    editor._tiptapEditor.schema,
+    editor
+  );
+  const externalHTML = exporter.exportBlocks(blocks);
+  const externalHTMLSnapshotPath =
+    "./__snapshots__/" +
+    snapshotDirectory +
+    "/" +
+    snapshotName +
+    "/external.html";
+  expect(externalHTML).toMatchFileSnapshot(externalHTMLSnapshotPath);
+}
+const testCases = [
+  defaultSchemaTestCases,
+  customBlocksTestCases,
+  customStylesTestCases,
+  customInlineContentTestCases,
+];
+describe("Test HTML conversion", () => {
+  for (const testCase of testCases) {
+    describe("Case: " + testCase.name, () => {
+      let editor: BlockNoteEditor<any, any, any>;
+      beforeEach(() => {
+        editor = testCase.createEditor();
+      });
+      afterEach(() => {
+        editor._tiptapEditor.destroy();
+        editor = undefined as any;
+        delete (window as Window & { __TEST_OPTIONS?: any }).__TEST_OPTIONS;
+      });
+      for (const document of testCase.documents) {
+        // eslint-disable-next-line no-loop-func
+        it("Convert " + document.name + " to HTML", async () => {
+          const nameSplit = document.name.split("/");
+          await convertToHTMLAndCompareSnapshots(
+            editor,
+            document.blocks,
+            nameSplit[0],
+            nameSplit[1]
+          );
+        });
+      }
+    });
+  }
+});

package/src/api/exporters/html/internalHTMLSerializer.ts ADDED Viewed

@@ -0,0 +1,80 @@
+import { DOMSerializer, Fragment, Node, Schema } from "prosemirror-model";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  PartialBlock,
+  StyleSchema,
+} from "../../../schema";
+import { blockToNode } from "../../nodeConversions/nodeConversions";
+import {
+  serializeNodeInner,
+  serializeProseMirrorFragment,
+} from "./util/sharedHTMLConversion";
+// Used to serialize BlockNote blocks and ProseMirror nodes to HTML without
+// losing data. Blocks are exported using the `toInternalHTML` method in their
+// `blockSpec`.
+//
+// The HTML created by this serializer is the same as what's rendered by the
+// editor to the DOM. This means that it retains the same structure as the
+// editor, including the `blockGroup` and `blockContainer` wrappers. This also
+// means that it can be converted back to the original blocks without any data
+// loss.
+//
+// The serializer has 2 main methods:
+// `serializeFragment`: Serializes a ProseMirror fragment to HTML. This is
+// mostly useful if you want to serialize a selection which may not start/end at
+// the start/end of a block.
+// `serializeBlocks`: Serializes an array of blocks to HTML.
+export interface InternalHTMLSerializer<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+> {
+  // TODO: Ideally we would expand the BlockNote API to support partial
+  //  selections so we don't need this.
+  serializeProseMirrorFragment: (fragment: Fragment) => string;
+  serializeBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;
+}
+export const createInternalHTMLSerializer = <
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  schema: Schema,
+  editor: BlockNoteEditor<BSchema, I, S>
+): InternalHTMLSerializer<BSchema, I, S> => {
+  const serializer = DOMSerializer.fromSchema(schema) as DOMSerializer & {
+    serializeNodeInner: (
+      node: Node,
+      options: { document?: Document }
+    ) => HTMLElement;
+    serializeBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;
+    serializeProseMirrorFragment: (
+      fragment: Fragment,
+      options?: { document?: Document | undefined } | undefined,
+      target?: HTMLElement | DocumentFragment | undefined
+    ) => string;
+  };
+  serializer.serializeNodeInner = (
+    node: Node,
+    options: { document?: Document }
+  ) => serializeNodeInner(node, options, serializer, editor, false);
+  serializer.serializeProseMirrorFragment = (fragment: Fragment) =>
+    serializeProseMirrorFragment(fragment, serializer);
+  serializer.serializeBlocks = (blocks: PartialBlock<BSchema, I, S>[]) => {
+    const nodes = blocks.map((block) =>
+      blockToNode(block, schema, editor.styleSchema)
+    );
+    const blockGroup = schema.nodes["blockGroup"].create(null, nodes);
+    return serializer.serializeProseMirrorFragment(Fragment.from(blockGroup));
+  };
+  return serializer;
+};

package/src/api/exporters/html/util/sharedHTMLConversion.ts ADDED Viewed

@@ -0,0 +1,128 @@
+import { DOMSerializer, Fragment, Node } from "prosemirror-model";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../../schema";
+import { nodeToBlock } from "../../../nodeConversions/nodeConversions";
+function doc(options: { document?: Document }) {
+  return options.document || window.document;
+}
+// Used to implement `serializeNodeInner` for the `internalHTMLSerializer` and
+// `externalHTMLExporter`. Changes how the content of `blockContainer` nodes is
+// serialized vs the default `DOMSerializer` implementation. For the
+// `blockContent` node, the `toInternalHTML` or `toExternalHTML` function of its
+// corresponding block is used for serialization instead of the node's
+// `renderHTML` method.
+export const serializeNodeInner = <
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  node: Node,
+  options: { document?: Document },
+  serializer: DOMSerializer,
+  editor: BlockNoteEditor<BSchema, I, S>,
+  toExternalHTML: boolean
+) => {
+  if (!serializer.nodes[node.type.name]) {
+    throw new Error("Serializer is missing a node type: " + node.type.name);
+  }
+  const { dom, contentDOM } = DOMSerializer.renderSpec(
+    doc(options),
+    serializer.nodes[node.type.name](node)
+  );
+  if (contentDOM) {
+    if (node.isLeaf) {
+      throw new RangeError("Content hole not allowed in a leaf node spec");
+    }
+    // Handles converting `blockContainer` nodes to HTML.
+    if (node.type.name === "blockContainer") {
+      const blockContentNode =
+        node.childCount > 0 &&
+        node.firstChild!.type.spec.group === "blockContent"
+          ? node.firstChild!
+          : undefined;
+      const blockGroupNode =
+        node.childCount > 0 && node.lastChild!.type.spec.group === "blockGroup"
+          ? node.lastChild!
+          : undefined;
+      // Converts `blockContent` node using the custom `blockSpec`'s
+      // `toExternalHTML` or `toInternalHTML` function.
+      // Note: While `blockContainer` nodes should always contain a
+      // `blockContent` node according to the schema, PM Fragments don't always
+      // conform to the schema. This is unintuitive but important as it occurs
+      // when copying only nested blocks.
+      if (blockContentNode !== undefined) {
+        const impl =
+          editor.blockImplementations[blockContentNode.type.name]
+            .implementation;
+        const toHTML = toExternalHTML
+          ? impl.toExternalHTML
+          : impl.toInternalHTML;
+        const blockContent = toHTML(
+          nodeToBlock(
+            node,
+            editor.blockSchema,
+            editor.inlineContentSchema,
+            editor.styleSchema,
+            editor.blockCache
+          ),
+          editor as any
+        );
+        // Converts inline nodes in the `blockContent` node's content to HTML
+        // using their `renderHTML` methods.
+        if (blockContent.contentDOM !== undefined) {
+          if (node.isLeaf) {
+            throw new RangeError(
+              "Content hole not allowed in a leaf node spec"
+            );
+          }
+          blockContent.contentDOM.appendChild(
+            serializer.serializeFragment(blockContentNode.content, options)
+          );
+        }
+        contentDOM.appendChild(blockContent.dom);
+      }
+      // Converts `blockGroup` node to HTML using its `renderHTML` method.
+      if (blockGroupNode !== undefined) {
+        serializer.serializeFragment(
+          Fragment.from(blockGroupNode),
+          options,
+          contentDOM
+        );
+      }
+    } else {
+      // Converts the node normally, i.e. using its `renderHTML method`.
+      serializer.serializeFragment(node.content, options, contentDOM);
+    }
+  }
+  return dom as HTMLElement;
+};
+// Used to implement `serializeProseMirrorFragment` for the
+// `internalHTMLSerializer` and `externalHTMLExporter`. Does basically the same
+// thing as `serializer.serializeFragment`, but takes fewer arguments and
+// returns a string instead, to make it easier to use.
+export const serializeProseMirrorFragment = (
+  fragment: Fragment,
+  serializer: DOMSerializer
+) => {
+  const internalHTML = serializer.serializeFragment(fragment);
+  const parent = document.createElement("div");
+  parent.appendChild(internalHTML);
+  return parent.innerHTML;
+};

package/src/api/{formatConversions → exporters/html/util}/simplifyBlocksRehypePlugin.ts RENAMED Viewed

@@ -22,6 +22,19 @@ export function simplifyBlocks(options: SimplifyBlocksOptions) {
   ]);
   const simplifyBlocksHelper = (tree: HASTParent) => {
+    // Checks whether blocks in the tree are wrapped by a parent `blockGroup`
+    // element, in which case the `blockGroup`'s children are lifted out, and it
+    // is removed.
+    if (
+      tree.children.length === 1 &&
+      (tree.children[0] as HASTElement).properties?.["dataNodeType"] ===
+        "blockGroup"
+    ) {
+      const blockGroup = tree.children[0] as HASTElement;
+      tree.children.pop();
+      tree.children.push(...blockGroup.children);
+    }
     let numChildElements = tree.children.length;
     let activeList: HASTElement | undefined;

package/src/api/exporters/markdown/__snapshots__/complex/misc/markdown.md ADDED Viewed

@@ -0,0 +1,5 @@
+## **Heading ***~~2~~*
+Paragraph
+*

package/src/api/exporters/markdown/__snapshots__/customParagraph/basic/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ Hello World

package/src/api/exporters/markdown/__snapshots__/customParagraph/nested/markdown.md ADDED Viewed

@@ -0,0 +1,5 @@
+Hello World
+Hello World
+Hello World

package/src/api/exporters/markdown/__snapshots__/customParagraph/styled/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ Hello World

package/src/api/exporters/markdown/__snapshots__/fontSize/basic/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ This is text with a custom fontSize

package/src/api/exporters/markdown/__snapshots__/hardbreak/basic/markdown.md ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ Text1\
2	+ Text2

package/src/api/exporters/markdown/__snapshots__/hardbreak/between-links/markdown.md ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ [Link1](https://www.website.com)\
2	+ [Link2](https://www.website2.com)

package/src/api/exporters/markdown/__snapshots__/hardbreak/end/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ Text1

package/src/api/exporters/markdown/__snapshots__/hardbreak/link/markdown.md ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ [Link1](https://www.website.com)\
2	+ [Link1](https://www.website.com)

package/src/api/exporters/markdown/__snapshots__/hardbreak/multiple/markdown.md ADDED Viewed

@@ -0,0 +1,3 @@
+Text1\
+Text2\
+Text3

package/src/api/exporters/markdown/__snapshots__/hardbreak/start/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ Text1

package/src/api/exporters/markdown/__snapshots__/hardbreak/styles/markdown.md ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ Text1\
2	+ Text2

package/src/api/exporters/markdown/__snapshots__/image/basic/markdown.md ADDED Viewed

@@ -0,0 +1,3 @@
+![](exampleURL)
+Caption

package/src/api/exporters/markdown/__snapshots__/image/button/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ Add Image

package/src/api/exporters/markdown/__snapshots__/image/nested/markdown.md ADDED Viewed

@@ -0,0 +1,7 @@
+![](exampleURL)
+Caption
+![](exampleURL)
+Caption

package/src/api/exporters/markdown/__snapshots__/link/adjacent/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ [Website](https://www.website.com)[Website2](https://www.website2.com)

package/src/api/exporters/markdown/__snapshots__/link/basic/markdown.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ [Website](https://www.website.com)