Custom properties
We have added specific custom frontmatter properties to meet specific needs.
Type: object optional
Description: Displays a Banner on the current docs page.
Type: string optional
Description: A canonical URL or path to set as the <link rel="canonical"> in the page <head>, overriding the default derived from the page URL.
Type: string optional
Description: Difficulty is displayed as a column in the ListTutorials component.
Type: string optional
Description: Path to another page in our docs or elsewhere. Used to add a crosslink entry to the lefthand navigation sidebar.
Type: boolean
Description: Whether to show the FeedbackPrompt on the page, defaults to true
Type: boolean optional
Description: Renders this group as a single link on the sidebar, to the index page. Refer to Sidebar.
Type: boolean optional
Description: If true, this property adds a noindex declaration to the page, which will tell internal / external search crawlers to ignore this page. Helpful for pages that are historically accurate, but no longer recommended, such as Workers Sites.
Type: string optional
Description: The purpose of the page, and defined through specific pages in Content strategy.
Type: array
Description: The names of related directory entries (according to their file name in src/content/directory). Usually, these correspond to file paths, but not always, such as with cloudflare-tunnel
Type: array optional
Description: Required for the ProductReleaseNotes component.
Type: undefined optional
Description: A YYYY-MM-DD value that signals when the page was last explicitly reviewed from beginning to end.
Type: object
Description: Used to configure various sidebar options. Refer to Sidebar.
Type: object optional
Description: Used by overrides for style guide component documentation, which helps us display the usage counts for components directly on the component page itself.
Type: string optional
Description: Renders a summary description directly below the page title.
Type: array optional
Description: A group of related keywords relating to the purpose of the page.