Pinnate Docs

GitHubApp

SEO metadata

Titles, descriptions, and social previews for docs pages.

Pages

Page title and description frontmatter feed the published <title>, meta description, and Open Graph / Twitter tags. Optional social image:

---
title: Authentication
description: API keys and OAuth.
og_image: https://cdn.example.com/auth-og.png
---

cover_url and image are accepted aliases for og_image.

Site defaults

Set site-wide defaults in site.yaml under seo: or metadata::

seo:
  description: Guides for the Acme API.
  og_image: https://cdn.example.com/docs-og.png
  twitter_card: summary_large_image

Page description and image override site defaults when present. Canonical URLs are generated from the public hostname and page path.

Also see robots.txt.