Markdown syntax

Write pages with Markdown for headings, lists, links, images and code. MDX adds reusable components when a page needs cards, steps or tabs.

Page structureCopy Anchor Link

Start with frontmatter. The template displays the page title, so begin body sections at H2:

---
title: Installation
description: Install the client and make your first request.
---

## Before you begin

Create an account and prepare your API key.

## Install the client

Follow the instructions for your environment.

Links and imagesCopy Anchor Link

[Read the quickstart](/docs/quickstart)

![Settings screen](/img/settings.png)

Use paths that exist in your project. Give images meaningful alt text and check local assets after publishing.

Code and tablesCopy Anchor Link

Add a language name after the opening code fence for syntax highlighting. Use tables for short comparisons or field descriptions. Keep wide examples readable on mobile.

MDXCopy Anchor Link

MDX supports JSX components. Keep blank lines around Markdown inside components and close every tag. Use the supported component reference rather than copying imports from another template.