Input formats

The SDK accepts four input formats. Whichever you hand it, you get the same editor and the same document model; the difference is how much of the original survives the trip in.

Format	Extensions	Notes
DOCX	`.docx`	Full fidelity — the only format carrying comments, tracked changes, sections, headers, and footnotes
Markdown	`.md`, `.markdown`	Headings, lists, tables, code, emphasis, links
Plain text	`.txt`	Paragraphs split on blank lines
HTML	`.html`, `.htm`	Headings, lists, tables, links, inline formatting

<ReviseEditor
  initialDocuments={[
    { id: "contract", docx: docxFile },
    { id: "notes", docx: markdownFile },
    { id: "brief", docx: htmlFile },
  ]}
/>

The field is called docx for backwards compatibility with hosts that predate the text formats. It accepts any supported source.

How the format is detected

In order:

An explicit format on the document input.
The filename extension, when the source is a File.
The MIME type, when the source is a Blob that carries one.
DOCX, as the fallback.

Declaring the format explicitly

A Blob or ArrayBuffer assembled in memory has no filename, and its MIME type may be missing or wrong. Say what it is:

<ReviseEditor
  initialDocuments={[
    {
      id: "draft",
      docx: new Blob([markdownString]),
      format: "markdown",
      title: "Draft",
    },
  ]}
/>

await editor.documents.open({
  id: "imported",
  docx: await response.blob(),
  format: "html",
});

Without a filename or MIME type, an undeclared source is treated as DOCX and will fail to parse if it is really text. Pass format whenever you build the source yourself.

What each format brings

DOCX

The high-fidelity path. Styles, fonts, tables, images, sections, page setup, running headers and footers, footnotes and endnotes, comments, and tracked changes all survive, and all of them come back out on export.

Markdown

Parsed into real blocks — headings become headings, tables become tables. Since Markdown has no concept of pagination or revision marks, the document opens with default page setup and no tracked changes.

Plain text

Blank-line-separated paragraphs. Useful for pasted content and transcripts.

HTML

Structural markup is mapped to document blocks. Scripts, styles, and layout CSS are ignored: this is a document importer, not a browser.

Titles

When you do not pass a title, the SDK derives one from the filename, minus the extension. Master Agreement.docx becomes “Master Agreement”.

Export

Export is DOCX:

const blob = await editor.tools.exportDocx();

A document imported from Markdown or HTML exports as a well-formed .docx, so the SDK doubles as a conversion step in a pipeline that ends in Word.

Getting started

Guides

API reference

How the format is detected

Declaring the format explicitly

What each format brings

Titles

Export

​How the format is detected

​Declaring the format explicitly

​What each format brings

​Titles

​Export

How the format is detected

Declaring the format explicitly

What each format brings

Titles

Export