Pinnate Docs

GitHubApp

Doc versions

Version switcher for published documentation snapshots.

Enable a version dropdown on the public docs header. Readers can browse recent published site snapshots (the same documents created each time you publish).

This is distinct from registry versions, which track API OpenAPI history.

Enable

Add a top-level versions block in site.yaml (or nest it under theme:):

versions:
  enabled: true
  max: 8
  labels:
    "0.55.0": Latest

Key

Default

Meaning

enabled

false

Show the header switcher

max

10

How many recent publishes to list (1–50)

labels

{}

Optional display labels keyed by publish version

After sync and publish, the site header shows a version select.

Browse a version

  • The current publish uses clean URLs (no query string).

  • Older publishes use ?v=<version> (for example /start/introduction?v=0.52.0).

  • Section tabs, sidebar links, and prev/next keep ?v= while you stay on that snapshot.

  • Historical views are noindex; search stays on the current publish only.

  • Sitemap, llms.txt, and robots always reflect the current publish.

Notes

  • Switching versions loads that publish’s Markdown nav and pages from the snapshot.

  • Embedded API / SDK / CLI reference panels still resolve from the live registry resources (not frozen OpenAPI inside the site snapshot).

  • Fern-style parallel folder trees (multiple doc roots in one repo) are not required for this switcher.