# Reed Docs

> Reed — the documentation compiler. One source, every surface; the output is yours.

## Docs

- [Reed](https://reedbuild.dev/docs/): One source of truth, compiled into every documentation surface.
- [Quickstart](https://reedbuild.dev/docs/quickstart/): From nothing to a deployable documentation site in five minutes.
- [Project anatomy](https://reedbuild.dev/docs/project-anatomy/): What lives in a Reed project, and which parts you commit.
- [Pages](https://reedbuild.dev/docs/authoring/pages/): Frontmatter, the page id, and the fixed component catalog.
- [Navigation](https://reedbuild.dev/docs/authoring/navigation/): Tabs, groups, and the two page shapes you author by hand.
- [Using components](https://reedbuild.dev/docs/authoring/components/): A tour of the catalog, and how to choose.
- [Content dialect](https://reedbuild.dev/docs/authoring/dialect/): The one field migrated MDX almost always needs.
- [MDX pitfalls](https://reedbuild.dev/docs/authoring/mdx-pitfalls/): The four failures that cost the most time, and what to do instead.
- [Templates](https://reedbuild.dev/docs/design/templates/): mint, rapide, black — and what a template actually owns.
- [Colors and the CSS cascade](https://reedbuild.dev/docs/design/colors/): Six color keys, and the four layers your styles land in.
- [Typography and layout](https://reedbuild.dev/docs/design/typography-layout/): Fonts, dimensions, and the difference between omitting a field and setting it.
- [Logo, favicon and custom CSS](https://reedbuild.dev/docs/design/assets/): Local files, how they resolve, and the currentColor trap.
- [site and base](https://reedbuild.dev/docs/site/addressing/): What a site can only do once it knows its own address.
- [head injection](https://reedbuild.dev/docs/site/head/): Data-only meta and link tags — and why there is no script field.
- [Structured data](https://reedbuild.dev/docs/site/structured-data/): What Reed derives per page, and what you supply yourself.
- [Redirects](https://reedbuild.dev/docs/site/redirects/): Real redirects, compiled — not a client-side hack.
- [Discovery](https://reedbuild.dev/docs/site/discovery/): sitemap.xml, robots.txt, and the three paths to llms.txt.
- [Analytics](https://reedbuild.dev/docs/site/analytics/): Six supported providers, configured by value — never by script tag.
- [OpenAPI specs](https://reedbuild.dev/docs/api/specs/): Point Reed at a spec and get a generated section.
- [Code snippets](https://reedbuild.dev/docs/api/snippets/): Five languages per operation, derived from the spec.
- [One source, every surface](https://reedbuild.dev/docs/derived/overview/): What Reed emits besides a website, and why it comes from one representation.
- [llms.txt and markdown mirrors](https://reedbuild.dev/docs/derived/llms-txt/): The whole site as plain text, plus one .md per page.
- [MCP server generation](https://reedbuild.dev/docs/derived/mcp/): A tool set derived from your spec, as source you own.
- [Agent Skill generation](https://reedbuild.dev/docs/derived/skill/): A Skill pack from your spec, carrying your own prose with it.
- [Build output](https://reedbuild.dev/docs/ship/output/): Everything reed build writes, and what each part is for.
- [Deploy](https://reedbuild.dev/docs/ship/deploy/): Put the built directory on any static host — there is no Reed runtime.
- [Response headers](https://reedbuild.dev/docs/ship/headers/): The _headers file, why it exists, and where it has to live.
- [Offline builds in CI](https://reedbuild.dev/docs/ship/ci-offline/): Prefetch once, then build with no network — and the cache mistake that quietly undoes it.
- [What you actually own](https://reedbuild.dev/docs/ship/self-host/): The guarantee, stated precisely enough to be checkable.
- [Migrating from Fern](https://reedbuild.dev/docs/migrate/fern/): What the importer converts, and the order to work through afterwards.
- [Known import gaps](https://reedbuild.dev/docs/migrate/fern-gaps/): Every diagnostic the importer emits, what it means, and what you must fix by hand.

## Changelog

- [Changelog](https://reedbuild.dev/docs/changelog/): What has shipped in Reed, newest first.
- [Roadmap](https://reedbuild.dev/docs/roadmap/): What Reed does not do yet, stated plainly.

## Reference

- [Required fields](https://reedbuild.dev/docs/reference/docs-json/required/): The four fields every docs.json must have.
- [Appearance](https://reedbuild.dev/docs/reference/docs-json/appearance/): typography, layout, logo, favicon and customCss.
- [navigation](https://reedbuild.dev/docs/reference/docs-json/navigation/): The exact shape and limits of the navigation tree.
- [API and generation](https://reedbuild.dev/docs/reference/docs-json/api/): api, snippets, mcp, skill and capabilityIdentity.
- [Addressing, head and SEO](https://reedbuild.dev/docs/reference/docs-json/site/): site, base, head, seo, jsonLd, structuredData, analytics and redirects.
- [Navbar, footer and reserved fields](https://reedbuild.dev/docs/reference/docs-json/chrome/): navbar-links, footer, content, $schema, and the three reserved keys.
- [reed init](https://reedbuild.dev/docs/reference/cli/init/): Scaffold a new documentation project.
- [reed import](https://reedbuild.dev/docs/reference/cli/import/): Convert an existing Fern project into a Reed project.
- [reed check](https://reedbuild.dev/docs/reference/cli/check/): Validate the config and content without building. Always offline.
- [reed dev](https://reedbuild.dev/docs/reference/cli/dev/): Live preview while you edit.
- [reed build](https://reedbuild.dev/docs/reference/cli/build/): Compile the project into a deployable static site.
- [reed prefetch](https://reedbuild.dev/docs/reference/cli/prefetch/): The one command that touches the network. Run it once per machine.
- [reed mcp generate](https://reedbuild.dev/docs/reference/cli/mcp-generate/): Generate an MCP server from a configured OpenAPI spec.
- [reed skill generate](https://reedbuild.dev/docs/reference/cli/skill-generate/): Generate an Agent Skill pack from a configured OpenAPI spec.
- [Callouts](https://reedbuild.dev/docs/reference/components/callouts/): Callout and its nine fixed-intent shorthands.
- [Layout and surfaces](https://reedbuild.dev/docs/reference/components/layout/): Cards, grids, frames, panels, banners and accordions.
- [Steps, tabs and code](https://reedbuild.dev/docs/reference/components/procedural/): Sequences, alternatives, and code presentation.
- [API reference components](https://reedbuild.dev/docs/reference/components/api/): Parameters, response fields, badges and tables.
- [File trees](https://reedbuild.dev/docs/reference/components/file-tree/): Files, Folder and File.
- [Expandable, Icon, Tooltip, Update](https://reedbuild.dev/docs/reference/components/misc/): The remaining four components.
- [Diagnostics](https://reedbuild.dev/docs/reference/diagnostics/): Every DS-* code, what triggers it, and whether it fails the build.
- [Environment variables](https://reedbuild.dev/docs/reference/env/): The four variables Reed reads.