# Welcome to OINK

> Product guides, configuration, components, and deployment reference

---

LLMS index: [llms.txt](/llms.txt)

---

<!-- markdownlint-disable-next-line no-space-in-links -->

<span class="badge bg-primary text-bg-primary fs-6">v0.16.0
</span>

Welcome to the OINK user guide for version `v0.16.0`. This guide
covers the theme's Hugo-only build, local-first runtime, multilingual framework,
content components, customization, and deployment.

## What is OINK?

OINK is an independent theme for the [Hugo][] static site generator, designed
for medium and large technical documentation sets. It evolves [Docsy][]
directly: Docsy's mature content model and documentation features remain
available, while OINK provides a new canonical shell, local dependencies, and
reusable components drawn from production PGSTY sites.

A consuming site can build with Hugo Extended alone. It does not need Node.js,
npm, PostCSS, Autoprefixer, or a CDN. Bootstrap, Font Awesome, fonts, local
search, diagrams, API documentation runtimes, and content components ship with
the theme and are loaded only when a page needs them.

OINK includes:

- a responsive documentation and blog shell with navigation, table of contents,
  search, print output, dark mode, and accessible interactions;
- a general multilingual framework with translated-page routing, missing-page
  fallback, language weights, RTL support, and SEO alternate metadata;
- local Mermaid, KaTeX, Markmap, Swagger UI, Redoc, Asciinema, ECharts, and
  Infographic runtimes;
- reusable details, tabs, cards, navigation cards, and document carousels;
- a bilingual starter, Cloudflare Pages guidance, an air-gap distribution, and
  an auditable vendor manifest.

OINK itself does **not** provide source hosting or deploy your generated site.
Keep your project in GitHub, GitLab, a private Git service, or a local
repository, then publish Hugo's static output with the platform of your choice.

## Is OINK for me?

OINK is most useful when a documentation project has many pages, several content
types, multiple languages, or strict reproducibility and network isolation
requirements. It is also a good fit when several sites should share a single
maintained shell instead of copying layouts, scripts, and shortcodes.

For a project with only one or two pages and no structured navigation, a README
or a smaller Hugo theme may be simpler. For a heavily application-driven portal,
use OINK for the documentation surface and keep business-specific components in
the site rather than forcing them into the theme.

## Ready to get started?

Read the [OINK overview](/docs/oink/) to understand the product boundaries, then
[build the bilingual starter](/docs/oink/getting-started/). The remaining user
guide documents the inherited Docsy content model and the compatible APIs that
OINK continues to support.

[Docsy]: https://github.com/google/docsy
[Hugo]: https://gohugo.io/

---

Section pages:

- [Get started](/docs/get-started/): Build a bilingual Oink documentation site with Hugo Extended.
- [Content and Customization](/docs/content/): How to add content to and customize your Docsy site.
- [OINK](/docs/oink/): Product boundaries, architecture, and operating model
- [Deployment and previews](/docs/deployment/): Deploying your Docsy site.
- [Multi-language support](/docs/language/): Configure languages, translations, stable links, search, and RTL.
- [Update OINK](/docs/update/): Update the theme, Hugo Extended, and local overrides safely.
- [Best Practices](/docs/best-practices/): Optional guidance and recommendations about organizing, authoring, and managing your technical documentation.
- [Contribution guidelines](/docs/contributing/): How to contribute code and bilingual documentation to OINK.
- [About OINK](/docs/about/): OINK is a local-first, Hugo-only theme for multilingual technical documentation