Renderings
One Page record, five renderings: HTML for people, JSON and Markdown for agents, a share image and an email.
A rendering is one output format of a record. One record has five, and each reads the same fields and the same Theme.
Five renderings
| Rendering | Export | Address on this site |
|---|---|---|
| HTML | renderPage | /, from pages/home.json |
| JSON | The record itself | /pages/home.json |
| Markdown | pageMarkdown, unpublished | Every docs page at its address plus .md |
| Share image | og, unpublished | — |
email, unpublished | — |
JSON
The record is its own JSON rendering. This site serves each living page's record beside its render, byte for byte, and /schema.json beside them.
Markdown
pageMarkdown renders a record as Markdown for an agent: headings, prose, tables, and each code window as a fence. The docs pages here are Markdown already, served at their address plus .md.
Share image
A share image is the 1200 by 630 picture a link shows when shared. It draws the page's title and description under its Theme, and the page's meta.image points at it.
Six transactional emails every product sends, each in the product's Theme: welcome, usage, limit, webhook, plan and billing. Each reads the Product record and one event.