Releases#

A page with template: releases.html lists versions with their notes and downloadable assets. Each asset shows its size and a SHA-256 checksum that copies on click. See this site's releases.

docs/releases.md

---
template: releases.html
releases: releases.yml
---

# Releases

Download the latest version, or browse the history.

releases is either a list in the front matter or a path to a YAML file relative to docs/.

docs/releases.yml

- version: 0.2.0
  date: 2026-12-01
  summary: Versioned docs and a Japanese interface.
  notes: |
    - **New:** `version_provider: mike`.
    - **Fixed:** tabs no longer jump when switching.
  assets:
    - name: mkdocs_sumi-0.2.0-py3-none-any.whl
      url: https://example.com/mkdocs_sumi-0.2.0-py3-none-any.whl
      size: 1.9 MB
      sha256: 9f2c0a…
- version: 0.1.0
  date: 2026-11-01
  notes: First release.

Fields#

versionstring

Version number; also the anchor, so releases/#v0-2-0 links to it.

titlestring

Shown instead of the version, if set.

datedate

Release date.

statusstring

latest, stable, prerelease or archived. The first release defaults to latest.

summarystring

One line under the heading.

notesstring

Release notes in Markdown.

assetslist

Downloads: name, url, size, sha256.

The page's own Markdown is shown above the list, so you can add installation instructions or a support policy.