Skip to content
Cloudflare Docs

Custom properties

We have added specific custom frontmatter properties to meet specific needs.

Properties

Type: object optional

Description: Displays a Banner on the current docs page.

chatbot_deprioritize

Type: boolean optional

Description: If true, this property will de-prioritize this page in the responses surfaced by Support AI. Helpful for pages that are historically accurate, but no longer recommended, such as Workers Sites. Companion to the noindex property.

difficulty

Type: union optional

Description: Difficulty is displayed as a column in the ListTutorials component.

Allowed values
  • Beginner
  • Intermediate
  • Advanced

Type: string optional

Description: Path to another page in our docs or elsewhere. Used to add a crosslink entry to the lefthand navigation sidebar.

feedback

Type: boolean

Description: Whether to show the FeedbackPrompt on the page, defaults to true

goal

Type: array optional

hideChildren

Type: boolean optional

Description: Renders this group as a single link on the sidebar, to the index page. Refer to Sidebar.

icon

Type: object optional

noindex

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. Companion to the chatbot_deprioritize property.

operation

Type: array optional

pcx_content_type

Type: union optional

Description: The purpose of the page, and defined through specific pages in Content strategy.

Allowed values
  • changelog
  • changelog-entry
  • configuration
  • concept
  • design-guide
  • example
  • faq
  • get-started
  • how-to
  • integration-guide
  • implementation-guide
  • learning-unit
  • navigation
  • overview
  • reference
  • reference-architecture
  • reference-architecture-diagram
  • release-notes
  • troubleshooting
  • tutorial
  • video

preview_image

Type: string optional

Description: A src path to the image that you want to use as a custom preview image for social sharing.

products

Type: array optional

Description: The names of related products, which show on some grids for Examples, Tutorials, and Reference Architectures

release_notes_file_name

Type: array optional

Description: Required for the ProductReleaseNotes component.

reviewed

Type: date optional

Description: A YYYY-MM-DD value that signals when the page was last explicitly reviewed from beginning to end. This is used to automatically add the LastReviewed component. Commonly related to tutorials and reference architectures.

Type: object

Description: Used to configure various sidebar options. Refer to Sidebar.

spotlight

Type: object optional

Description: These are used to automatically add the SpotlightAuthorDetails component to the page.

styleGuide

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.

summary

Type: string optional

Description: Renders a summary description directly below the page title.

tags

Type: array optional

Description: A group of related keywords relating to the purpose of the page. Refer to Tags.