Markdown
Write guide pages with GitHub-flavored Markdown and frontmatter.
Guide pages are GitHub-flavored Markdown (.md or .mdx extension). The importer converts Markdown to the editor document model and HTML for the public site.
Supported today
Headings, paragraphs, emphasis, links, images
Fenced code blocks and inline code
Lists, blockquotes, thematic breaks
GFM tables
Relative links between pages (rewritten on import)
Container directives for callouts, steps, cards, and tabs
Example page:
---
title: Authentication
description: API keys and OAuth.
position: 40
---
# Authentication
Use a bearer token:
```http
Authorization: Bearer sk_…
```
| Scheme | Use |
| --- | --- |
| API key | Server-to-server |
Directives
See Components for :::callout, :::steps, :::card, and :::tabs syntax. These round-trip through the console editor.
Not supported in synced Markdown
Raw HTML is stripped on import. JSX/MDX components do not render—use directives instead.
Frontmatter
See Page settings and Frontmatter reference.
Media
Images via standard Markdown image syntax. See Media.