# Mail Quilt

> A set of free, MIT-licensed packages for building email design into any web app: a ready-made drag-and-drop editor, and the document model and renderer it's built on.

## Docs

### Get started

- [Introduction](https://editor.mailquilt.com/docs): What Mail Quilt is, how it works, and what to know before you rely on it.
- [Quick start](https://editor.mailquilt.com/docs/quick-start): Add the Mail Quilt email editor to your app with a bundler, from a CDN with no build step, or in React, then save emails and export them as HTML.
- [Shell](https://editor.mailquilt.com/docs/shell): Put a ready-made email editor page in your app, with a header, Export and Import buttons, messages and saving in the browser.
- [Packages](https://editor.mailquilt.com/docs/packages): The four Mail Quilt packages, what each one is for and which one to install.

### Guides

- [Theme tokens](https://editor.mailquilt.com/docs/theme-tokens): Match the editor to your app by changing its colors, spacing, corners and font with CSS custom properties on the mail-quilt element.
- [Keyboard and screen readers](https://editor.mailquilt.com/docs/keyboard): Every key the Mail Quilt editor answers to, what a screen reader announces, and how the editor's accessibility is tested.
- [Render on a server](https://editor.mailquilt.com/docs/render-on-a-server): Turn a saved Mail Quilt email into HTML on your server with the renderer package, without loading the editor.
- [Change emails in code](https://editor.mailquilt.com/docs/change-emails-in-code): Create, check and change Mail Quilt emails without the editor, using the core package's Commands, undo history and document loader.

### Reference

- [Document format](https://editor.mailquilt.com/docs/document-format): The JSON format Mail Quilt saves emails in: Rows, Columns and Blocks, every Block's props, and which colors, links and sizes the editor accepts.
- [Tested email clients](https://editor.mailquilt.com/docs/email-clients): Which email clients the HTML that Mail Quilt exports has been checked in. Gmail and Apple Mail will be checked before 0.1.0, and Outlook is untested.

## Agent skills

- [mail-quilt](https://editor.mailquilt.com/.well-known/agent-skills/mail-quilt/SKILL.md): Read the Mail Quilt docs instead of answering from memory. A set of free, MIT-licensed packages for building email design into any web app: a ready-made drag-and-drop editor, and the document model and renderer it's built on. Use when a task involves Mail Quilt: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://editor.mailquilt.com/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://editor.mailquilt.com/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://editor.mailquilt.com/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://editor.mailquilt.com/openapi.json.
- [Agent skills](https://editor.mailquilt.com/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://editor.mailquilt.com/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://editor.mailquilt.com/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://editor.mailquilt.com/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://editor.mailquilt.com/sitemap.xml): Every indexable page URL with its last-modified date.