BREASE.md
A file in the repository that tells the AI how the site is built.
The AI reads BREASE.md from the site's root folder (the repository root, or the root directory set for the site in a monorepo) at the start of every editor session (up to 20,000 characters). It follows what the file says, and when one of its changes alters a convention the file describes, it updates that part. It doesn't create the file unless asked.
Brease already gives the AI the page tree, the navigations, the source files three folders deep (as they were when the session started), the template names from content.schema.json and which file renders each data-brease-block. Use BREASE.md for what it can't work out from those: where content is read, what each template holds, and the rules of the codebase.
What to put in it
- Stack: framework, styling approach, fonts, package manager. Anything the site deliberately avoids (for example "no tracking scripts").
- Where content is read: the client and loader file, the route that renders pages, the templates file, how locales reach components, sitemap, robots, redirects and the revalidate route.
- Content model: a table of pages or templates and what their content holds, plus field rules (allowed HTML tags, the asset shape, which lists are built from other pages).
- Editor markers: how
data-breasepaths are formed in this codebase, including the prefix for other pages' content, the navigation keys and the section names. - Caching: revalidation interval and cache tags.
- Commands: install, dev, typecheck, lint.
Keep it short and factual. The starter's BREASE.md is a complete example:
## Content model
| Page (id) | Slug | Template | Holds |
|---|---|---|---|
| `pg_home` | `""` | `home` | `hero` (eyebrow, title, text, `cta`), `features` (title, `items[]`), `closing` (title, text, `cta`) |
| `pg_about` | `about` | `page` | `title`, `intro`, `body` (HTML) |
| `pg_global` | `_global` | `global` | `siteName`, `footer` (text, copyright) |
- New simple pages use the `page` template. A page that needs its own layout gets a new template.
- `body` is HTML: `<p>`, `<h2>`, `<h3>`, lists, `<blockquote>`, with `<strong>`, `<em>` and `<a href>` inline.Sites that weren't built for Brease
An existing site can keep its own structure. Describe that structure in BREASE.md, including any adapter code that turns Brease content into the shapes old components expect. The AI then works within it instead of moving the site to the recommended structure.