Example sites
Explore the full project site, the theme example, and a minimal bilingual consumer.
About Oink
Understand Oink’s examples, design principles, architecture, and open-source model.
OINK turns Markdown, configuration, and local assets into a complete technical documentation site. With the theme source and Hugo Extended, a site can build documentation, a blog, multilingual navigation, local search, diagrams, API references, and reusable content components without maintaining a frontend toolchain.
What Oink provides
| Capability | Theme contract |
|---|---|
| Documentation and blog layouts | Responsive navigation, breadcrumbs, table of contents, page metadata, feedback, print output, and content indexes |
| Multilingual behavior | Translated-page routing, language metadata, stable anchors, and per-language local search |
| Local-first browser features | Versioned styles, fonts, search, diagrams, API references, recordings, charts, and infographics |
| Content components | Tabs, details, steps, cards, carousels, diagrams, terminal recordings, charts, and parameter substitution |
| Reproducible delivery | A Hugo-only consumer build, pinned assets, an auditable vendor manifest, and regression fixtures |
OINK evolves Docsy’s mature Hugo content model into one independent theme. It uses Hugo as its build platform and takes design inspiration from Fumadocs. The open-source licenses page records those relationships and keeps upstream lineage, inspiration, dependencies, and licensing distinct.
Explore the project
The About section follows the lifecycle from evaluation through maintenance:
- Example sites shows the full bilingual project site, the small theme example, and the guide for creating a minimal consumer.
- Local-first operation defines which build and browser capabilities work without hidden network access.
- Architecture explains the repository, build, page-shell, runtime, and extension boundaries.
- Contribution guidelines covers theme and bilingual documentation changes.
- Release process separates source completion, validation, public release, documentation updates, and hosted deployment.
- Open-source licenses explains provenance, dependencies, acknowledgements, and the licenses for the site and theme.
Repository boundaries
The published Hugo Module is
github.com/pgsty/oink. Documentation,
examples, and regression tests live in the independent
github.com/pgsty/oink.pgsty.com
repository. Production consumers should pin a released tag or an immutable
commit.
Site-specific content, branding, configuration, and business components remain under site control. General-purpose layouts, reusable components, local browser runtimes, and translations belong in the theme.
Start here
- Install Oink or create a bilingual site.
- Review the content authoring guide and advanced features.
- Read the implementation diary for design decisions and verification evidence.
A successful local build proves that one source tree renders in one local environment. It does not prove that a theme tag is public or that the hosted site contains the same commit.
Local-first operation
Build and browse Oink without hidden network access.
Architecture
See how Oink turns content and local assets into a static site.
Contribution guidelines
Contribute code and bilingual documentation to Oink.
Release process
Release the Oink theme and update its independent project site.
Open-source licenses and acknowledgements
Understand Oink’s upstream lineage, dependencies, acknowledgements, and licensing boundaries.