Alpha: Ships on npm at 7.0.0-alpha.07.0.0-alpha.0
Page fields and bounds
Every Page, section and shell field: its type, its bounds and the anchor of its refusal, beside the smallest record that parses.
Point at a field to light the line of the smallest record that sets it. Each Section type's own fields are on its page under Section types.
From PageSchema and SectionSchema of @mdxui/site@7.0.0-alpha.0. A refusal link opens the exact message a value past that bound returns.
Page
18 fields. A Page holds its Theme, its head and three to twenty sections.
| Field | Type | Req | Bounds | Refusal |
|---|---|---|---|---|
theme | one of 5certificatevaultlinequaypointcallboarddirectory | yes | — | page.theme |
template | one of 7api-productarticleblogpostcontactdirectory-listdirectory-product | — | ||
title | string ≤64 | yes | 1–64 | page.title |
description | string ≤320 | yes | 1–320 | page.description |
meta | object | — | ||
meta.canonical | string ≤160 | 1–160 | page.meta.canonical | |
meta.type | one of 2websitearticle | — | ||
meta.icon | string ≤160 | 1–160 | page.meta.icon | |
meta.iconFallback | string ≤160 | 1–160 | page.meta.iconFallback | |
meta.appleTouchIcon | string ≤160 | 1–160 | page.meta.appleTouchIcon | |
meta.image | object | — | ||
meta.image.url | string ≤160 | yes | 1–160 | page.meta.image.url |
meta.image.width | integer 200–2400 | yes | 200–2400 | page.meta.image.width |
meta.image.height | integer 200–2400 | yes | 200–2400 | page.meta.image.height |
meta.noindex | boolean | — | ||
jsonLd | 0–4 × object | ≤4 | ||
frame | one of 3nonesheetsplit | yes | — | |
sections | 3–20 × object | yes | 3–20 | page.sections |
Section and shell
9 fields around every section. The section’s block is one Section type, and each type’s fields are on its own page.
| Field | Type | Req | Bounds | Refusal |
|---|---|---|---|---|
kind | one of 8navbarherobandsectionarticleclosingfooter | yes | — | |
shell | object | yes | — | |
shell.id | string (pattern) | — | shell.id | |
shell.inset | one of 4containedbleedarticlelisting | yes | — | |
shell.density | one of 9nonesectioncompactheroclosingfooteraccessarticlelisting | yes | — | |
shell.surface | one of 4papertintplateglass | — | ||
shell.background | one of 4nonedotsgrainglow | — | ||
shell.sticky | boolean | — | ||
shell.aside | boolean | — |