OINK 1.2 · Local-first · Built with Hugo
Technical content, written in Markdown.
Four styles for docs, blogs, books and API references.
Why OINK
Shared navigation, search and publishing tools for your technical content.
01 / ENGINEERING FIRST
◇ Ship docs, not build pipelines
Focus on documentation, not site plumbing.
02 / FOUR STYLES
◇ Paper · Slate · Ink · Terminal
Same content, a different feel. Fonts and core scripts stay local.
03 / LOCAL FIRST
◇ Bundled assets, no npm build step
Hugo Modules need Go for resolution; external integrations remain your choice.
# one command, one deterministic output
$ hugo --gc --minify
✓ assets bundled locally
✓ multilingual routes built
✓ public/ ready to deploy
04 / EXTENSIBLE
◇ First-class components, loaded per page
Component scripts load only on pages that use them.
Beyond docs
Documentation sites rarely stay documentation-only. The shapes that normally need a second tool share this one’s shell, search and outputs.
Sidebar tree, page outline, breadcrumbs, pager, edit and history links — the shell every other content type reuses.
Dated posts, count-sorted tag panels, and a separate feed for each language.
Chapter numbers, {#id num=} figures and equations, xref cross-references, and whole-book print.
One data/download/*.yaml becomes release cards, asset tables and checksums. Publication state is data.
Twenty-two server-rendered sections compose a page. The one you are reading is one of them.
Swagger UI and Redoc as local runtimes. Keep the spec in the repository; it works offline.
Component reference
Each component has its own page and a defined shape in HTML, print, Markdown and RSS. Interactive runtimes ship only on pages that use them.
echarts data fence
declarative data fence
mind maps from headings
terminal casts, local player
UML through your own server
diagrams that stay editable
local diagram runtime
KaTeX at build time
filetree data fence
gallery data fence
Chroma · lines · copy · fold
captions · sizing · zoom
captions · numbers · matrix
a table plus {.fields}
> [!NOTE] · 10 types
fences with {tab=}
a list plus {.steps}
a list plus {.cards}
inline status, five tones
key names and chords
files, params, build notes
Cases
English, Chinese and bilingual; distribution manuals, product docs, three books, a company page, an extension catalog and a two-page tool. Every card opens the live site; the Case library explains the content model behind each one.
pgsty.comPGSTY: the company behind Pigsty.
pigsty.ccPIGSTY: the Chinese home of the open-source PostgreSQL distribution.
pigsty.ioPIGSTY: the English home of the open-source PostgreSQL distribution.
silo.pgsty.comSILO: the community-maintained MinIO fork for S3-compatible object storage.
oink.pgsty.comOINK: the Hugo theme every site in this library is built with.
caps.vonng.comCapsLock: turn the most useless key on the keyboard into a fifth modifier.
pig.pgsty.comPIG: the package manager that installs any PostgreSQL extension.
sow.pgsty.comSOW: the repository manager that builds and mirrors APT and YUM software repositories.
exp.pgsty.comPG Exporter: the Prometheus metrics exporter for PostgreSQL and Pgbouncer.
ddia.vonng.comDDIA: the Chinese edition of Designing Data-Intensive Applications.
tpme.vonng.comTPME: the Chinese edition of The Product-Minded Engineer.
pgint.vonng.comPG Internals: the Chinese edition of PostgreSQL Internals.
PostgreSQL ecosystem libraryA Hugo operations library for PostgreSQL components, with shared search and navigation across upstream manuals and partially translated language trees..
pgsty.proPIGSTY PRO: the enterprise edition of Pigsty.
ext.pgsty.comPGEXT: the PostgreSQL extension catalog.Before you commit
No. The build dependency is Hugo Extended (0.160.1 or newer). Go is used once, to resolve the theme as a Hugo module; an offline archive or a Git submodule works without it. Interactive features still run JavaScript, but those scripts ship with the theme and attach only to the pages that use them.
Content and front matter mostly carry over; the shell, navigation, search and components are replaced. Renamed keys fail the build with the new name, and bin/migrations/oink06.py reports what it would rewrite before it writes anything. Read Upgrade and migration.
No. The example sites run from a two-page project site to a fifteen-hundred-file distribution manual, and one uses OINK for landing pages alone. The shell scales down as well as up.
Local search uses Lunr for Latin scripts and a substring fallback for CJK, so those pages are searchable without a hosted service. OINK 1.2 ships 32 native interface catalogs with locale-aware plurals and translated appearance controls, including English, Simplified Chinese (zh-cn, zh) and Traditional Chinese (zh-tw). RTL layouts are supported.
Open Appearance from the sun or moon button, choose Paper, Slate, Ink or Terminal, then select light, dark or system mode. Paper is the new default; Slate preserves the previous look. Site owners choose which presets to offer, and Ink/Terminal currently require explicit opt-in. Fonts and core scripts are served locally. See what changed in 1.2 and the appearance guide.
With markdown in outputs, every page has an index.md sibling announced by rel="alternate", and the LLMS format writes a site-level llms.txt. The “open in ChatGPT / Claude” page actions exist but are off by default, because they hand the reader’s URL to a third party.
Apache License 2.0. OINK is a fork of Docsy that evolved independently; Docsy’s history, attribution and Apache-2.0 obligations are preserved, and every vendored runtime is listed with its license in VENDOR.json. See License and acknowledgements.
Start from a repository that already works.Use OINK Starter, replace the identity and content, then publish with a warning-strict Hugo build.