Introduction on OINK

Highlights

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

This page lists what separates OINK from an ordinary Hugo theme, each item ending with the guide that covers it. To install straight away, see Quick start.

Components are written in Markdown

A callout is a > [!NOTE] blockquote (ten semantic types plus one neutral disclosure). A field list is a table with a {.fields} line. Steps and cards are lists with {.steps} / {.cards}. A caption is a {caption="…"} line under an image. Tabs are adjacent fences each carrying a {tab="…"}; file trees, galleries, Mermaid and ECharts are data fences named after their language. On GitHub or in any plain Markdown reader these degrade to blockquotes, tables, lists and code blocks, and nothing is lost.

What is OINK

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

OINK is a standalone Hugo theme for medium and large technical documentation sites. It evolved from Docsy: the content model and the multilingual behaviour are kept, while the shell, navigation, search and content components are replaced.

A consuming site’s only build dependency is one Hugo Extended binary. There is no Node.js, no npm, no PostCSS and no CDN request. Bootstrap, Font Awesome, the fonts, local search, the diagram runtimes and the API reference runtimes are all committed to the theme repository and shipped only to the pages that use them.

Case Guide

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

The canonical Case library turns fifteen production sites into short, reusable implementation patterns, and the home page mirrors the same fifteen. All of them run OINK, including this documentation site itself as a self-referential case.

Use this guide when you know the shape of the site you want to build. Follow a case for its architecture and trade-offs, then use the linked documentation for the exact configuration. Counts in individual cases describe the audited snapshot rather than a permanent property of a live site.

License and acknowledgements

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

OINK is three layers of material: the theme source, the documentation content, and the third-party assets shipped with the theme. None of them is relicensed into a single combined work. Every table below points at the authoritative file in the repository; where a summary and the licence text disagree, the file wins.

Which licence covers what

Scope	Licence	Authoritative file
OINK theme source (layouts, partials, shortcodes, SCSS, JS, i18n)	Apache License 2.0	Theme `LICENSE`, `NOTICE`
This site’s own code, build scripts and material derived from Docsy	Apache License 2.0	Site `LICENSE`, `NOTICE`
This site’s original documentation content, except where stated otherwise	Creative Commons Attribution 4.0 International	Site `LICENSE-CC-BY-4.0`
Browser libraries, fonts and icons shipped with the theme	Each component’s own licence	Theme `VENDOR.json` and the licence files beside each asset

Two boundaries are worth keeping straight. CC BY 4.0 covers the original documentation content only, not the theme code, the trademarks, the screenshots or the third-party assets. And the theme being Apache-2.0 does not turn its bundled dependencies into Apache-licensed works.