Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Last updated on

Frontmatter

↑ Docs content model

Frontmatter is the YAML metadata block at the top of every page, which sets fields such as the description, content type, and sidebar behavior.

When to use​

Every page has a frontmatter block — it's the first thing in the file. Use it to set the page's SEO description and to classify the page, and reach for the optional fields when a page needs a custom URL, needs to be hidden, or needs a source-of-record date.

Technical details​

Frontmatter is a YAML block fenced by --- on its own line at the very top of the file. The fields used in this project:

  • description (required) — a one-sentence SEO description, 100–160 characters. It's the summary search engines and AI answer engines show, and it can contain :re[...] tokens.
  • content_type — the page's type, from a controlled vocabulary (validated in src/frontMatter/). Common values: how-to, concept-article, tutorial, overview, landing-page, reference, language-reference, release-notes, troubleshooting, best-practice, get-started. This maps to the page type.
  • content_tags — a nested object grouping the page: product_lines (for example, ['Lakeflow Pipelines']) and topics.
  • slug — a custom URL path, overriding the file-path default.
  • unlisted — hides the page from the sidebar and search while still building it. Use true for all clouds, or a per-cloud object such as unlisted: { azure: true }.
  • last_update — an explicit last-reviewed date.

The page title comes from the body # H1, not a frontmatter title field.

Rules​

  • Every page opens with a frontmatter block, and it includes a description.
  • content_type must be one of the controlled values.
  • Keep description to 100–160 characters.
  • Set the title with the body H1, not a title: field.

Style​

  • Write description as a complete sentence that front-loads the page's key terms, so it reads well as a search snippet.
  • Tag content_tags consistently with sibling pages in the same product area.

Template​

YAML
---
description: 'One-sentence, 100–160 character summary of the page for search and AI answers.'
content_tags:
  product_lines: ['<Product line>']
  topics: ['<Topic>']
content_type: how-to
---

Examples​

Example:

YAML
---
description: 'Monitor Lakeflow Jobs in the :re[Databricks] UI: view jobs and runs, inspect run details and status, and export run results.'
content_tags:
  product_lines: ['Lakeflow Jobs']
  topics: ['Jobs/Workflows']
content_type: how-to
---

Used in​

Content atoms appear in any page section. Frontmatter is unique among atoms: it appears exactly once per page, at the top, and its content_type names the page's page type.

On this page