Skip to content
Cloudflare Docs

Custom properties

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

Properties

content_type

Type: string optional

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.

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.

languages

Type: array 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.

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
  • overview
  • get-started
  • how-to
  • concept
  • reference
  • reference-architecture
  • reference-architecture-diagram
  • tutorial
  • api
  • troubleshooting
  • faq
  • integration-guide
  • changelog
  • configuration
  • navigation
  • example
  • learning-unit
  • design-guide
  • 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

release_notes_product_area_name

Type: string optional

Type: object optional

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

summary

Type: string optional

tags

Type: array optional

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

updated

Type: date optional

Description: This is used to automatically add the LastReviewed component.