Acme Docsdocs

Pages

How pages and frontmatter work

Every .mdx file becomes a page. The file path determines the URL.

Frontmatter

Each page starts with frontmatter between --- fences:

---
title: Authentication
description: API keys, OAuth tokens, and webhook signatures
---

Your content starts here.
FieldRequiredDescription
titleYesPage title — browser tab and sidebar
descriptionNoMeta description for SEO
sidebarTitleNoShorter name for the sidebar (overrides title)
iconNoFont Awesome icon next to the page in the sidebar
openapiNoOpenAPI operation to auto-generate an API reference page

File structure → URLs

introduction.mdx        → /introduction
quickstart.mdx          → /quickstart
guides/webhooks.mdx     → /guides/webhooks
api/payments/list.mdx   → /api/payments/list

Markdown

MDX supports everything in standard Markdown:

  • Bold and italic text
  • Inline code and fenced code blocks
  • Links and images
  • Ordered and unordered lists
  • Tables and blockquotes
  • Headings (##, ###, ####)

Headings automatically appear in the right sidebar as a table of contents.

Pages