Chromatic docs

The main branch is automatically deployed to https://www.chromatic.com/docs/

Deployment

Available at docs.chromatic.com and via Netlify’s build previews on branches/PRs. The ‘website’ proxies this to https://www.chromatic.com/docs/

To configure, access the Netlify dashboard.

Deploy previews are set up for PRs.

🚀 Project Structure

This project uses Astro. Inside, you’ll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── content/
│   ├── getStarted/
│   │   └── introduction.md
│   ├── notInNavigation/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── BaseLayout.astro
│   └── pages/
│       └── index.astro
└── package.json

🧞 Commands

All commands are run from the root of the project, from a terminal:

LLM documentation exports

Every pnpm build regenerates dist/llms.txt, dist/llms-full.txt, and dist/llms/.txt from the rendered articles. This includes FAQs, CMS pages, imported snippets, generated references, all tab panels, and disclosures. Removed articles are removed from the exports on the next build.

Pages in notInNavigation and pages marked isHidden retain individual text exports but are excluded from the index and full corpus. The exporter checks article identities, nonempty content, and coverage consistency before the build succeeds.

Use pnpm build followed by pnpm preview to inspect the exports under /docs/ and test Copy Markdown. Exports are not served during pnpm dev, where Copy Markdown is hidden.

✍️ Editing Content

Try to follow the conventions present.

⚠️ Note: Prettier doesn’t yet support MDX v2 so, for now, you’ll need to format nested code snippets manually and wrap them with prettier-ignore. For example:

{/* prettier-ignore-start */}

  
    ```bash