OINK Documentation
For a new OINK site, Start with the Starter. Preview the working site, then replace its sample content. Write in Markdown and build with Hugo Extended with its built-in Sass compiler. Hugo Modules also require Go to resolve the theme. Bundled theme assets require no CDN or npm build step.
The current release is v1.5.1. See the 1.5.1 release notes or the upgrade guide for an existing site.
Five ways in
- Get started — Create an OINK Starter repository. Verify the local site, customize one part at a time, then deploy it.
- Components — Each component has one page. The source appears first, followed by the rendered result.
- Write Beautiful Docs — Follow a six-chapter hands-on walkthrough from cloning the Starter to publishing a polished bilingual site.
- Case studies — Learn reusable design and migration patterns from production sites.
- Design and development — Read 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 |
| Build an image album or browse the live gallery | Expo albums · Live Expo |
| Change the name, logo, colors, 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 first six sections in the sidebar (Introduction, Get started, Authoring, Components, Customization, and Operations) are for site authors and operators. Design and CLI at the bottom are reference material for OINK theme contributors.
A local-first Hugo documentation framework that evolved from Docsy. Its components remain readable in Markdown. The theme includes its assets. Fifteen production sites use it.
Start from the official OINK Starter. Verify the local site, then customize content, language, brand, integrations, and deployment in that order.
Write documentation pages, blog posts, books, release pages, and API references. Learn the page structure and content organization.
Find each writing component, from simple examples to detailed examples, with its output matrix, parameters, and limits.
Configure the site brand, navigation, layout, search, languages, versions, print output, and agent output.
Preview, deploy, and maintain a site. Configure comments, analytics, and SEO. Upgrade the theme and diagnose problems.
OINK’s contracts, accepted decisions, dated research, and active proposals in one bilingual section.
An introduction to the optional OINK command-line companion for Hugo sites. The CLI is still a draft.