Writing Docs

How to author documentation pages in Markdown or MDX.

Docs live in apps/marketing/src/content/docs/ as .md or .mdx files. Every file needs title, description, and order frontmatter — the sidebar sorts by order.

Plain Markdown

Use .md for prose-only pages. Headings, tables, code blocks, and links are styled by the site’s .docs-prose styles automatically.

MDX

Use .mdx when a page needs components. Import them at the top of the file, right after the frontmatter, and use them inline:

Rendered from @pairlens/ui inside MDX
---
title: My Page
description: One-liner for the docs index.
order: 6
---

import { Badge } from '@pairlens/ui/components/ui/badge'

<Badge>It works</Badge>

Components render statically at build time. Add a client:load directive only if a component genuinely needs interactivity in the browser.