Supported file formats
DraftView reviews documentation files in pull requests.
Supported extensions
| Format | Extensions |
|---|---|
| Markdown | .md, .markdown, .mdown |
| MDX | .mdx |
| AsciiDoc | .adoc, .asciidoc, .ad, .asc |
| Markdoc | .mdoc, .markdoc |
DraftView also parses MyST Markdown syntax in Markdown files.
Component support
DraftView supports common docs component syntax in supported files, including MDX components and DocsLit wc-* components.
MyST Markdown
- Admonition directives, such as
:::{note}, render as native admonitions. - Tab, card, grid, and dropdown directives render as rich components.
- Code and figure directives render as code blocks and images.
- DraftView preserves unknown directives and inline roles verbatim, so they round-trip exactly.
Markdoc
- Tags such as
{% callout %}and{% tabs %}render as rich components with editable bodies. - DraftView preserves self-closing tags, such as
{% partial /%}, verbatim.
Images
- Markdown, MDX, and AsciiDoc images render inline in the editor, including images referenced by relative paths in the repository.
- Images that the PR itself adds or moves resolve against the PR head commit.
- Raw HTML image blocks in Markdown files, such as badge and logo headers, render as image previews.
Round-trip behavior
DraftView keeps source format on submit.
- Markdown edits return as Markdown.
- MDX edits return as MDX.
- AsciiDoc edits return as AsciiDoc.
- MyST and Markdoc edits return in their own syntax, including directive options and tag attributes.
Not supported
- Code and config files for prose editing
- Binary documents and image formats as editable prose