YAML frontmatter

YAML frontmatter is a block of structured metadata written in YAML that sits at the very top of a plain text or Markdown file. It is always enclosed by three dashes (---) on the first line and another set of three dashes or dots below it. [1, 2, 3]

You can use YAML frontmatter to:

• define versioning,
• add metadata
• control the layout for articles

effectiveDate

• Purpose: Set an effective date for Terms of Service articles so that engineering teams can automatically re-prompt users to confirm the terms
• Type: string YEAR-MONTH-DAY e.g. 2021-10-04 is October 4th, 2021
• Optional.

showMiniToc

• Purpose: Indicates whether an article should show a mini table of contents (TOC) above the rest of the content. For more information, see Autogenerated mini TOCs.

• Type: Boolean. Default is true on articles, and false on map topics and index.md pages.
• Optional.

In this Note: