License and acknowledgements
OINK contains three types of material: theme source, documentation content, and bundled third-party assets. These materials are not relicensed as a single combined work. Each table below links to the authoritative repository file. If a summary disagrees with the license text, the file is authoritative.
Which licence covers what
| Scope | Licence | Authoritative file |
|---|---|---|
| OINK theme source (layouts, partials, shortcodes, SCSS, JS, i18n) | Apache License 2.0 | Theme LICENSE, NOTICE |
| This site’s own code, build scripts and material derived from Docsy | Apache License 2.0 | Site LICENSE, NOTICE |
| This site’s original documentation content, except where stated otherwise | Creative Commons Attribution 4.0 International | Site LICENSE-CC-BY-4.0 |
| Browser libraries, fonts and icons shipped with the theme | Each component’s own licence | Theme VENDOR.json and the licence files beside each asset |
CC BY 4.0 covers only the original documentation content. It does not cover theme code, trademarks, screenshots, or third-party assets. The theme’s Apache-2.0 license does not change the licenses of its bundled dependencies.
Community contributors
OINK is maintained by PGSTY. Thank you to @imbajin for reporting and contributing the following reading repairs, with fixtures, regression tests, and bilingual docs. Introduced in 1.3.1, these fixes remain included in 1.5.1.
| Contribution | Pull request |
|---|---|
| Markmap node text across light/dark modes and visual presets | Theme #48 |
| Fixed TOC clearance above the footer | Theme #50 |
Complete FileTree comments, integrated behind wrap=true |
Theme #52 |
| Readable technical tables with an opt-in layout | Theme #54 |
| Bilingual contracts, release documentation, and companion regression coverage | Documentation #11 |
The release notes record the integration details. To contribute a correction, translation, or fix, follow the contribution guide.
Upstream: Docsy
The theme’s NOTICE records these facts:
- OINK is derived from Docsy, Copyright 2018 Google LLC and Docsy contributors.
- OINK’s own theme work is Copyright 2026 PGSTY contributors.
- The project and its upstream both use Apache License 2.0.
VENDOR.jsonrecords each third-party browser dependency’s license, source, version, and checksum. Each required NOTICE file accompanies its asset. - The Docsy name and Google’s trademarks belong to their respective holders. These names identify the upstream project and imply no endorsement.
This site also derives from the Docsy project website. The site’s NOTICE
records that origin. Docsy is OINK’s only code upstream. OINK retains its source
history, Apache-2.0 obligations, and copyright notices. Modified files carry
a modification notice, as Apache-2.0 requires.
Third-party runtimes shipped with the theme
The theme commits everything the browser needs to the repository
(assets/third_party/, assets/js/third_party/, static/webfonts/). These
assets need no npm step or build-time download. Hugo Module resolution still
needs Go and an available module source. VENDOR.json
is the machine-readable manifest for these assets. Each entry records the name,
pinned version, source URL, license file path, and SHA-256 of every selected
artifact. It also records an aggregate checksum for each of the three asset trees.
The table below matches the OINK v1.5.1 manifest
(VENDOR.json generated 2026-10-25, schema 1, 29 entries). Versions change
with each theme release. Use the manifest from your pinned theme version. Every source is the
npm registry (https://registry.npmjs.org/…).
| Package | Version | Licence | What it does in the theme |
|---|---|---|---|
| bootstrap | 5.3.8 | MIT | Grid, components and the RTL stylesheet |
| @popperjs/core | 2.11.8 | MIT | Overlay positioning for Bootstrap |
| @fortawesome/fontawesome-free | 7.3.1 | CC-BY-4.0 AND OFL-1.1 AND MIT | Icons throughout the site |
| @fontsource-variable/inter | 5.3.0 | OFL-1.1 | Interface and body font |
| @fontsource-variable/ibm-plex-sans | 5.3.0 | OFL-1.1 | Body font for Paper and Terminal |
| @fontsource/chakra-petch | 5.3.0 | OFL-1.1 | Brand display font |
| @fontsource/ibm-plex-mono | 5.3.0 | OFL-1.1 | Code font |
| lunr | 2.3.9 | MIT | Local full-text search |
| @docsearch/js | 5.0.4 | MIT | The optional Algolia DocSearch front end |
| @docsearch/css | 5.0.4 | MIT | Its stylesheet |
| mermaid | 11.17.2 | MIT | Mermaid diagrams |
| katex | 0.18.4 | MIT | Mathematics |
| markmap-autoloader | 0.18.12 | MIT | Mind maps |
| markmap-lib | 0.18.12 | MIT | Mind maps |
| markmap-view | 0.18.12 | MIT | Mind maps |
| markmap-toolbar | 0.18.12 | MIT | Mind map toolbar |
| d3 | 7.9.0 | ISC | Markmap dependency |
| @highlightjs/cdn-assets | 11.12.0 | BSD-3-Clause | Markmap dependency |
| webfontloader | 1.6.28 | Apache-2.0 | Markmap dependency |
| swagger-ui-dist | 5.32.14 | Apache-2.0 | OpenAPI reference pages |
| redoc | 2.5.3 | MIT | OpenAPI reference pages |
| asciinema-player | 3.17.0 | Apache-2.0 | Terminal recording playback |
| echarts | 6.1.0 | Apache-2.0 | Charts |
| @antv/infographic | 0.2.19 | MIT | Infographics |
| pako | 3.0.1 | MIT AND Zlib | Decompression (diagram data) |
| external-svg-loader | 1.7.1 | MIT | Inlining external SVG |
| idb-keyval | 6.2.0 | Apache-2.0 | Browser-side caching |
License texts accompany their assets. Examples include
assets/third_party/bootstrap/LICENSE and
assets/third_party/katex/LICENSE. Swagger UI, Redoc, and ECharts also include
their own NOTICE or bundled-declaration files. Lunr is the only exception. Its
code is in assets/js/third_party/. Its license is at
assets/third_party/lunr/LICENSE.
The OINK 1.4.0 local PlantUML integration adds @plantuml/core 1.2026.9 (MIT)
and Viz.js 3.24.0 (MIT), including Graphviz 14.1.1 (EPL-1.0) and Expat (MIT).
Their notices and upstream source links accompany the two scripts in
assets/third_party/plantuml/; VENDOR.json records the exact artifacts.
When you redistribute the theme, include all this license and notice material. When you update a runtime, update its artifact, license file, source, and checksum in the same change.
Fonts and icons
Inter, IBM Plex Sans, Chakra Petch, and IBM Plex Mono use the SIL Open Font
License 1.1. OINK 1.5.1 includes 33 files under static/webfonts/: fourteen
Inter subsets, twelve IBM Plex Sans subsets, four brand-font files, and three
Font Awesome files. Font Awesome Free 7.3.1 uses a composite license. Its icon artwork uses
CC BY 4.0, its font files use SIL OFL 1.1, and its code uses MIT. The text is
in assets/third_party/Font-Awesome/LICENSE.txt.
The theme makes no request to a remote font service. The repository has no
Google Fonts link. The site always serves fonts from its own baseURL. To change fonts or switch to the platform stack, see
Brand and appearance.
Design references
Docsy is the only code upstream. The projects below are references for the design language. They supply no code or runtime dependencies. OINK has ported no code from them:
| Project | What was learned from it |
|---|---|
| Fumadocs | Content-first presentation, information hierarchy, and writing components such as file trees and field lists (the theme’s NOTICE records this acknowledgement) |
| Nextra | A simple documentation shell, filename labels and copy controls on code blocks, and per-page layout switches |
| Hextra | A Hugo-native approach to implementation, file trees, badges, tabs |
| Mintlify | Layered navigation structure, synchronized code groups, the reading experience of an API reference |
Hugo is the build platform, and Go resolves modules when the theme is installed as a Hugo Module. Both are prerequisites, and the theme redistributes neither binary.
These names describe origin, dependency, or design references. They imply no endorsement by these projects. Project and product names belong to their respective holders.
Reusing this documentation
CC BY 4.0 permits sharing and adaptation for any purpose under these conditions. Give attribution, link to the license, and state whether you made changes. Do not imply endorsement by OINK, PGSTY, or any upstream project. This attribution is sufficient:
Adapted from the OINK documentation by PGSTY contributors, licensed under CC BY 4.0, with modifications.
Images or quotations with their own attribution keep their own credit and license. Removing the footer does not remove the attribution obligation.
Reusing the theme
Apache-2.0 permits using, modifying, and distributing the theme source and build
output under its terms. Keep the license, copyright, and attribution notices.
Keep the contents of NOTICE. When you distribute modified source, state
which files you changed. A theme distribution should include
LICENSE, NOTICE, VENDOR.json, and every third-party licence file the
manifest references.
Apache-2.0 grants no trademark rights. It does not change third-party assets into Apache-licensed works.
Related
- Contributing — report problems, improve docs, and submit fixes
- What is OINK — what the project is and where it came from
- Highlights — what local-first means in practice
- Configuration — which features bring in an external service
- Brand and appearance — changing fonts and icons