fix: Visual differences between live editor and rendered exported HTML #2348
+1,434
−317
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
nperez0111
reviewed
Jan 14, 2026
Comment on lines
145
to
158
| // Set of transforms to run on the output HTML element after serializing | ||
| // blocks. These are used to add HTML elements, attributes, or class names | ||
| // which would normally be done by extensions and plugins. Since these don't | ||
| // run when converting blocks to HTML, tranforms are used to mock their | ||
| // functionality so that the rendered HTML looks identical to that of a live | ||
| // editor. | ||
| const transforms: ((element: HTMLElement) => HTMLElement)[] = [ | ||
| addIndexToNumberedListItems, | ||
| makeCheckListItemsReadOnly, | ||
| forceToggleBlocksShow, | ||
| addTableMinCellWidths, | ||
| addTableWrappers, | ||
| addTrailingBreakToEmptyInlineContent, | ||
| ]; |
Contributor
There was a problem hiding this comment.
This is fantastic @matthewlipski I'm really happy with how this came out
@blocknote/ariakit
@blocknote/code-block
@blocknote/core
@blocknote/mantine
@blocknote/react
@blocknote/server-util
@blocknote/shadcn
@blocknote/xl-ai
@blocknote/xl-docx-exporter
@blocknote/xl-email-exporter
@blocknote/xl-multi-column
@blocknote/xl-odt-exporter
@blocknote/xl-pdf-exporter
commit: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes some visual & DOM inconsistencies between the rendered HTML from a live editor, and the rendered static HTML from exporting blocks.
These differences come mostly from plugins/extensions that use decorations not running when doing an export, as well as a few other fixes due to the HTML being static.
Rationale
One of the use cases of BlockNote is writing content in the editor, taking advantage of its UX and formatting, then exporting that content to HTML so it can be displayed read-only without requiring an editor instance.
However, this is only useful if the static HTML output closely matches what a user sees when editing content in BlockNote.
Changes
transformstocreateInternalHTMLSerializer. These are functions which modify the HTML element created from exporting blocks. SeeinternalHTMLSerializer.tsfor more info.Impact
N/A
Testing
An e2e test has been added which tests that the Default Schema Showcase example page is visually identical to the new Rendering HTML Converted From Blocks example page.
Screenshots/Video
N/A
Checklist
Additional Notes