Frontmatter overrides site defaults from docs.json for this page only. Unknown keys are ignored; docs.page does not validate page YAML against a schema. For writing guidance, see Write.
---
title: Install the CLI
description: Install the docs.page CLI on macOS, Linux, or Windows.
---Page title for the browser tab, visible page hero (when enabled), search index, and Open Graph metadata.
Falls back to the site name from docs.json when omitted. With docs check --metadata, warns when title is missing on pages that use auto-generated social preview images.
Short summary shown under the page title and used in metadata, search results, and social previews.
Falls back to the site description from docs.json when omitted. With docs check --metadata, warns when description is missing on pages that use auto-generated social preview images.
Hero image path or URL rendered below the title block when showPageImage is enabled.
Overrides site-wide socialPreview for Open Graph on this page. Paths are resolved relative to the repository root, using the same rules as Image.
When false, hide the rendered title and description hero for this page.
When omitted, inherits content.showPageTitle from docs.json. Default site value: true.
When false, hide the frontmatter image hero for this page.
When omitted, inherits content.showPageImage from docs.json. Default site value: true.
When true, add noindex to this page's metadata so search engines skip it.
Site-wide blocking uses seo.noindex in docs.json instead. See Search engine indexing.
Root-relative path to send readers when they request this page's URL. docs.page responds with an HTTP redirect before rendering body content.
Keep a stub file at the old path. docs check validates that the target resolves to a real page. See Redirects.
Root-relative path for the Previous footer link. Overrides sidebar-inferred navigation when content.automaticallyInferNextPrevious is enabled.
External URLs are ignored. docs check validates internal targets.
Custom label for the Previous footer link. When omitted, the title is taken from the matching sidebar entry.
Root-relative path for the Next footer link. Overrides sidebar-inferred navigation when automatic inference is enabled.
External URLs are ignored. docs check validates internal targets.
Custom label for the Next footer link. When omitted, the title is taken from the matching sidebar entry.