Page status
1 minute read
A page-status banner tells a reader that a page is experimental, beta, or deprecated. The doc layout reads the page's front matter and puts the banner above the title; the same component can be shown inside a page with a directive.
Syntax
In front matter:
status: beta
since: 0.3.0
To preview one inside a page:
:::page-status{status=deprecated since="0.2.0" replaced_by="/components/callout/"}
:::
Options
| Name | Type | Default | What it does |
|---|---|---|---|
status |
experimental, beta, or deprecated |
none | The banner's kind. Any other value renders nothing. |
since |
string | none | The version when the status was set, shown as "Since 0.3.0". |
replaced_by |
site path or https URL |
none | The replacement page. Only a deprecated page shows it. |
Example
ExperimentalSince 0.3.0
DeprecatedSince 0.2.0Go to the replacement
Notes
status,since, andreplaced_byare front matter keys. The directive is for a preview inside a page; a real page uses front matter.- A
replaced_bythat is not a root-relative path or anhttpsURL is shown as text, not a link. - Remove the status when the feature is stable. A beta banner left on a finished page is worse than no banner.