OINK examples and templates

Build the bilingual starter, explore OINK features, and compare inherited Docsy references

This repository includes a complete bilingual starter and a documentation site that exercises the OINK product surface. Use them to validate a checkout, learn the content model, or start a new site without assembling a frontend toolchain.

The current checkout is an implementation preview. A working local example is evidence that the source builds; it is not by itself evidence of a public OINK release, stable remote module path, or hosted production deployment.

Included bilingual starter

The starter/ directory is the smallest complete OINK site. It ships with English and Simplified Chinese pages, local search, language-aware navigation, dark mode, a documentation section, a blog, and Cloudflare Pages configuration. After obtaining the complete repository, run:

hugo --source starter server --disableFastRender

Create its production output with Hugo alone:

hugo --source starter --gc --minify

The starter resolves the sibling theme/ checkout for local development. A released consumer site should pin the declared OINK module version or use a complete audited theme archive. Follow Build the bilingual starter for the prerequisites, repository layout, deployment options, and network-isolated workflow.

Reference pages in this site

The oink.pgsty.com/ site doubles as OINK’s documentation and regression surface. These pages demonstrate the parts most useful when evaluating the theme:

Page	What it demonstrates
OINK product reference	Product boundaries, repository map, and operating contract
Content components	Details, tabs, cards, diagrams, recordings, charts, and API references
Multi-language support	Side-by-side translations, stable IDs, routing, SEO, and local search
Implementation diary	Design decisions, delivered work, verification evidence, and remaining release gates

Upstream Docsy ecosystem

OINK evolved directly from Docsy and intentionally retains compatible content conventions where they remain useful. The following production sites are upstream Docsy references: they show the scale and variety of sites supported by the inherited content model, but they are not claims that those sites run OINK.

Examples with low to moderate customization:

Site	Source repository
Docsy	https://github.com/google/docsy
AgileBase docs	https://github.com/okohll/abdocs
Agones.dev	https://github.com/googleforgames/agones/tree/main/site
Apache Parquet	https://github.com/apache/parquet-site
CloudWeGo.io	https://github.com/cloudwego/cloudwego.github.io
etcd.io	https://github.com/etcd-io/website
fission.io	https://github.com/fission/fission.io
fluxcd.io	https://github.com/fluxcd/website
Graphviz	https://gitlab.com/graphviz/graphviz.gitlab.io
gRPC	https://github.com/grpc/grpc.io
JVMPerf.net	https://github.com/cchesser/java-perf-workshop
Kubeflow.org	https://github.com/kubeflow/website
Layer5 Docs	https://github.com/layer5io/docs
Navidrome Music Server	https://github.com/navidrome/website
OpenTelemetry.io	https://github.com/open-telemetry/opentelemetry.io
protobuf.dev	https://github.com/protocolbuffers/protocolbuffers.github.io
Selenium.dev	https://github.com/SeleniumHQ/seleniumhq.github.io
Stroom.io	https://github.com/gchq/stroom-docs
tekton.dev	https://github.com/tektoncd/website
YMCA Website Services	https://github.com/YCloudYUSA/yusaopeny_docs

Highly customized upstream references

These Docsy-based sites demonstrate how far the inherited templates and content conventions can be customized. They are compatibility references, not OINK deployments:

Site	Source repository
Apache Airflow	https://github.com/apache/airflow-site/
Docsy Mostly Docs	https://github.com/gwatts/mostlydocs/
Kubernetes	https://github.com/kubernetes/website
XLT	https://github.com/Xceptance/xlt-documentation
Dapr	https://github.com/dapr/docs