Footnotes and endnotes
The DOCX import service extracts footnote and endnote content from imported documents. However, this data is only available via the REST API. The editor extension does not surface footnotes or endnotes in the onImport callback. There is no editor extension to render footnotes, and export is not supported.
Support overview
| Import | Editor | Export | |
|---|---|---|---|
| Footnotes | REST API only (not in extension callback) | No extension | In development |
| Endnotes | REST API only (not in extension callback) | No extension | In development |
Import
Footnote and endnote data is only available via the REST API. The editor extension calls the same API but does not include this data in the onImport callback.
The REST API extracts footnotes and endnotes from the DOCX and returns them as footnotes and endnotes fields in the response, keyed by note ID. Inline references in the body text are represented as footnoteReference and endnoteReference nodes with a noteId attribute.
Extension does not surface footnote/endnote data
To access footnote and endnote data, use the REST API directly. The footnoteReference and endnoteReference nodes in the body text require a custom extension to render in the editor. See the invalid schema guide for strategies.
If you use the REST API directly, each footnote and endnote value is a Tiptap JSON document ({ type: "doc", content: [...] }). How you use this data is up to you. Some options include appending the notes as a numbered list at the end of the document, rendering them in a custom sidebar, or storing them for later use.
Editor
There is no footnote or endnote extension in Tiptap or Tiptap Pro. The editor schema has no built-in node or mark type that can represent footnote references or footnote content.
To render footnotes in your editor, you would need to build a custom extension that handles footnoteReference and endnoteReference node types and provides a UI for displaying the note content.
Export
Neither the editor extension nor the REST API exports footnotes or endnotes. There is currently no way to produce footnotes or endnotes in exported DOCX files.
Workarounds
If your workflow requires footnote-like content in the editor and exported documents, consider these alternatives:
- Inline parenthetical notes: Convert footnote content to parenthetical text within the body. This survives the full round-trip.
- Endnote section: Append a manually maintained "Notes" section at the end of the document using regular paragraphs and numbered text.
- Custom handling: Use the import callback to extract footnote data, store it alongside your document, and inject it back during a custom export step.