Skip to content
This page is also available as markdown at /docs/two-way-sync/supported-markdown.md. For the complete documentation index, see llms.txt.
Get started

Supported Markdown and limits

Which Markdown and MDX features sync with Falconer, and what to know before you sync.

Standard Markdown, including headings, lists, tables, code blocks, links, and images, is supported in .md and .mdx files.

New documents you create in Falconer are saved as .mdx files.

GitHub alert syntax such as > [!NOTE] and > [!WARNING] becomes a callout.

In .mdx files, these components render as rich blocks in Falconer:

ComponentTags
AccordionsAccordion, AccordionGroup
StepsSteps, Step
CardsCard, CardGroup
ColumnsColumns, Column
TabsTabs, Tab
Code groupsCodeGroup
FramesFrame
CalloutsNote, Tip, Info, Check, Warning, Callout
UpdatesUpdate

Other components, and listed components that use props Falconer doesn’t support, appear in Falconer as MDX code blocks. Components in .md files are treated as plain Markdown.

  • Markdown inside node_modules, vendor, and build output directories such as dist, build, target, and .next isn’t imported as documents. Every tracked file still appears in the Files tab.
  • Text files you can edit in Falconer are limited to 5 MB, other files to 100 MB, and the synced path’s total text, not counting Markdown, to 64 MB. See Images and other files.