Markdown and MDX
This section provides a complete reference for the Markdown and MDX syntax supported by Archbee, along with practical examples for every supported component.
If you're using Git Sync or following a docs-as-code workflow, and you prefer writing or editing documentation directly in your code editor or repository, this section is for you.
Standard Markdown
Archbee fully supports standard Markdown syntax for creating and formatting documentation. You can use familiar elements such as headings, lists, images, tables, blockquotes, code blocks, and more without any additional configuration.
MDX components
In addition to standard Markdown, Archbee extends the language with custom MDX components that enable richer documentation experiences. These components include tabs, callouts, workflows, API endpoints, link grids, expandable sections, and other interactive layouts.
ℹ️ Git-connected projects
When a Git-connected repository is synchronized with Archbee, Markdown (.md) files are automatically processed as MDX (.mdx). Existing Markdown syntax remains fully compatible, so your current content continues to render correctly while also giving you access to Archbee's extended component library.
What changed in the October 2026 update
The October 2026 update changed how Archbee converts documents to Markdown and MDX and back, so a document keeps its content and layout through an export and an import.
Git Sync files
The next time Archbee writes a document to your repository, some lines can change even where nobody edited the content. These are the new forms:
- Underlined text is written as <u>text</u>.
- Text in braces that is not a variable, such as /users/{id}, is written as /users/{id}, so it is not read back as a variable.
- A glossary term is written as :Variable[]{key="API key" type="glossary"}.
- A heading with a custom anchor is written as a Heading component that keeps the anchor. See Headings.
- An image, a code block or another block placed under a list item is written inside that item, indented under its text. See Lists.
- An image with a dark-mode version, or with a left or right alignment, is written as an Image component. See Images.
- In MDX files, every paragraph after the first one in a table cell is wrapped in a <Paragraph> component.
- Bold or italic applied to a whole link is written around the link, as in **[the guide](https://example.com/guide)**.
Importing Markdown and MDX
These changes apply to Git Sync, to Import with Markdown files, and to Markdown pasted into the editor.
- A block indented under a list item stays inside that item.
- Empty list items are kept.
- :::tip, :::info, :::note, :::warning and :::danger blocks become callouts.
- Escaped asterisks, as in \*\*not bold\*\*, stay plain text instead of turning bold.
- A code tab label can contain colons, such as Step 1: install. See Code editor: multi-language.
- A plain sentence that contains brackets or parentheses is pasted as plain text, not converted as Markdown.
Exporting Markdown
These changes apply to Export to Markdown file, Copy Markdown to clipboard, the Markdown version of published pages and the llms.txt file.
- Headings stay standard Markdown, such as ## Title, even when they have a custom anchor. Only Git Sync files keep the anchor.
- A Markdown table cell with several paragraphs or line breaks is written with <br />, so the table stays valid.
- Underlined text, text in braces and bold links are written as in Git Sync files.
- Spaces at the start or end of a paragraph are written as  , so they are kept.
Search
- A link inside bold or italic text is indexed with its address, like any other link.
- The first word after a link that ends a paragraph or a list item is indexed as its own word.