Writing pages
Author docs in MDX — frontmatter, Markdown, and headings that build your table of contents.
Author docs in MDX — frontmatter, Markdown, and headings that build your table of contents.
Pages are MDX files: standard Markdown, plus a few components for callouts, tabs, and code. Each page starts with frontmatter that sets its title and description.
Every page begins with a frontmatter block. title and description
drive the page header, the browser tab, and the page's meta description
for search engines:
---
title: Introduction
description: What Acme is and why you'd use it.
---
Welcome to Acme. This guide covers the basics.Sambadocs renders the title as the page's H1 automatically, so your
body should start at a second-level heading (##). You don't write the
# Title yourself.
Everything you'd expect works: bold, italic, links, lists, tables, blockquotes, and images. Standard GitHub-flavored Markdown.
Your ## and ### headings are collected into the “On this page”
outline on the right automatically — no extra work. Use them to give
each page a clear structure.
Reference images with a repo-relative path and Sambadocs serves them from your project:
