Scenario components on OINK

Sequential reading and mathematics

Mon, 01 Jan 0001 00:00:00 +0000

Oink 0.4.0 gives manuals, Books, and blogs a defined reading sequence. The same release also makes server-rendered mathematics a first-class content path.

The pager is enabled by default for the docs, book, and blog content types. Replace that set explicitly when a site uses only some of them:

YAML

params:
  ui:
    pager:
      types: [docs, book, blog]

Only those three type names are valid. A page or section can opt out with a boolean front matter value:

Releases and downloads

Mon, 01 Jan 0001 00:00:00 +0000

Oink separates immutable release facts from their presentation. A release page owns the version and repository identity; local download data owns distribution channels. Cards, lists, checksum tables, documentation pages, and Landing pages derive from those records instead of copying URLs and commands into several templates.

Define release facts

Add a strict release map to the page front matter:

YAML

release:
  product: Pig
  version: 1.7.0
  repo: pgsty/pig
  tag: v1.7.0
  date: 2026-08-14
  prev: v1.6.0
  checksums: SHA256SUMS

version and repo are required. Omit tag to derive v{version} and omit date to use the page date. Optional product, prev, and checksums fields complete the record. Unknown keys, wrong types, or a repository outside the owner/name form fail the build.

Landing pages

Mon, 01 Jan 0001 00:00:00 +0000

A Landing page is a regular Hugo content page with a full-width scenario shell. It keeps the site navbar, Command Palette, and configured footer, but removes the docs sidebar and table-of-contents rail. Content remains local and server-rendered; no frontend build or remote fact API is required.

The homepage continues to use data/home/<lang>.yaml, but now shares the same renderer and section contracts.

Create a Landing page

Create a regular content file and name its local data key:

Book publishing

Mon, 01 Jan 0001 00:00:00 +0000

Oink’s Book capability extends the documentation shell. It uses the existing content tree or data/docs_nav.json, the same breadcrumbs and pager, and the same output-aware component system. It does not introduce a second chapter manifest or a parallel navigation implementation.

Create the Book root

A section Book declares its type, requests the outputs it needs, and cascades the type to descendants:

YAML

---
title: Systems Handbook
type: book
book_kind: book
book_number: B
outputs: [HTML, print, markdown]
cascade:
  type: book
---

The Book root is always the current first section, even when the site enables a sidebar root switcher. Its navigation cannot leak into sibling docs or blogs. If a site overrides params.ui.shell_types, retain book in that list.

Scenario components on OINK

Sequential reading and mathematics

Enable or narrow the pager

Releases and downloads

Define release facts

Landing pages

Create a Landing page

Book publishing

Create the Book root