OINK Documentation
New to OINK? Start with the Starter to preview a working site, then replace its sample content. Write in Markdown and build with Hugo Extended; Hugo Modules also require Go to resolve the theme. Bundled theme assets need no CDN or npm build step.
The current release is v1.2.0. See the 1.2 release notes or the upgrade guide for an existing site.
Five ways in
- Get started — create an OINK Starter repository, establish a local baseline, customize it in layers, deploy.
- Components — one page per component, source first and rendered result after it.
- Write Beautiful Docs — a tutorial in progress; the first three chapters cover preview, structure and page composition.
- Case studies — production sites explained as reusable design and migration patterns.
- Design and development — contracts, accepted decisions, research evidence, and active proposals for OINK maintainers.
Find it by task
| What you want to do | Where to go |
|---|---|
| Decide whether it fits | What is OINK |
| Install and preview | Get started |
| Write a documentation page | Writing pages |
| Turn a directory tree into a sidebar | Organizing content |
| Look up a component’s syntax | Components |
| Change the name, logo, colours and fonts | Brand and appearance |
| Look up a configuration key’s default | Configuration |
| Run a bilingual or multilingual site | Languages |
| Practice building and writing | Write Beautiful Docs |
| Study a production implementation | Case studies |
| Deploy | Deploy |
| Upgrade, or migrate from Docsy | Upgrade |
| Maintain the theme, review a contract, or write a PRD | Design and development |
The seven Docs sections are ordered the way they are read: understand, install, write content, look up components, adjust the site, run the release, then study or maintain the contracts and design records behind it.
A local-first Hugo documentation framework evolved from Docsy. Its components stay readable in Markdown, its assets ship with the theme, and fifteen production sites exercise it.
Start from the official OINK Starter, establish a working local baseline, then customize content, language, brand, integrations, and deployment in that order.
Writing documentation pages, blog posts, books, release pages and API references — what a page looks like, and how content is organized.
Every component available for writing, one page each, examples from the simplest upwards, with the parameter table at the end.
Site-level configuration — brand, navigation, layout, search, languages, versions, print and agent output.
Running the site from a laptop to production — local preview, deployment, comments, analytics and SEO, upgrades and troubleshooting.
OINK maintainer contracts, accepted decisions, dated research, and proposals in one canonical bilingual section.
A draft introduction to the optional OINK command-line companion for Hugo sites.