Markdown Mirrors

Expose markdown versions of app pages so agents, crawlers, docs tools, and support workflows can read rendered content as text.

Farm supports two markdown flows:

• page.md and page.mdx are source-authored app pages.
• md mirrors convert rendered page.tsx routes back into markdown.

Use source-authored pages for static content such as about pages, policies, changelogs, and content-heavy marketing pages. Use mirrors when the canonical source is a React route.

Markdown app pages

---title: About Farmdescription: A markdown-first static page.---# About Farm<Callout>Farm can render MDX from the app router.</Callout>

This creates /about automatically. Because the route is source-authored markdown, Farm also serves the raw source at /about.md by default.

Configure MDX components

export default defineConfig({  mdx: {    components: "./src/markdown-components.tsx",    markdownRoutes: true,  },});

import { Callout } from "./components/callout";export const components = {  Callout,};

Set mdx.markdownRoutes to false when source-authored pages should render as HTML only.

Expose pages

export default defineConfig({  md: {    expose: ["/", "/pricing", "/docs"],    cache: 60,  },});

Routes

Use cases

• AI assistants can fetch page content without parsing the full app shell.
• Pricing, docs, changelog, and policy pages become easy to cite.
• Teams can keep one source of truth: the actual rendered page.

Expose every route

Use md: true when an internal app or documentation site should expose markdown mirrors for every rendered page.

export default defineConfig({  md: true,});

For public apps, prefer an explicit list so private or account pages are not exposed as markdown.

Per-route options

Routes can include a display title and cache override.

export default defineConfig({  md: {    expose: [      {        route: "/pricing",        title: "Pricing",        cache: 300,      },      "/docs/[...slug]",    ],    includeMetadata: true,  },});

What gets returned

Markdown mirrors call the rendered page, strip scripts/styles, convert HTML headings, paragraphs, lists, blockquotes, and code blocks into markdown, then return text/markdown.

curl http://localhost:3000/pricing.md

Production notes

• Expose only pages that are safe for agents and crawlers.
• Keep authenticated dashboards out of md.expose.
• Use cache for stable public pages.
• Use page.md or page.mdx when markdown is the source of truth.
• Use markdown mirrors for docs, pricing, policies, changelogs, release notes, and help center pages.