Docs / Authoring / Markdown & MDX

Markdown & MDX

Write documentation in Markdown with the power of JSX components when you need them.

Dustavez uses MDX — Markdown with optional JSX. This means every standard Markdown feature works out of the box, and you can drop in custom components for richer content when plain Markdown isn’t enough.

Standard Markdown

Everything you know about Markdown works here. Headings, paragraphs, links, lists, images, bold, italic, inline code, and code blocks all render with Dustavez’s carefully tuned typography.

example.mdx
# This is a heading
A paragraph with **bold**, *italic*, and `inline code`.
- Unordered list item
- Another item
1. Ordered list item
2. Another item
[A link to somewhere](/getting-started/installation)

Using components

MDX lets you import and use Astro (or React) components directly in your content files. Import at the top of the file, then use the component inline.

using-components.mdx
---
title: "My page"
description: "A page that uses components."
section: "Guides"
order: 1
---
import Callout from '@/components/mdx/Callout.astro';
Some regular Markdown content here.
<Callout type="tip" title="Pro tip">
Components can contain Markdown content too.
</Callout>
Note

Component imports must be placed after the frontmatter block and before the content. This is a requirement of the MDX format.

Available components

Dustavez ships with a focused set of components designed for documentation:

ComponentPurpose
CalloutNotes, warnings, and tips
Tabs / TabTabbed content panels
Steps / StepNumbered procedures
LinkGridNavigation card grids
ApiEndpointAPI method and path display
BadgeInline status labels

Each component is documented in its own page under the Authoring section.


Tables

Standard Markdown tables render with clean, minimal styling:

FeatureStatusVersion
MDX supportAvailable1.0
SearchAvailable1.0
i18nPlanned2.0

Horizontal rules

Use --- on its own line to create a horizontal rule. These are useful for separating major sections within a single page.

Last updated: April 4, 2026
Edit this page on GitHub