跳转到主要内容

开源许可与致谢

查清哪一层适用哪份许可证:主题 Apache-2.0、文档 CC BY 4.0、随主题分发的第三方运行时各自保留原许可。

OINK 由三层材料组成:主题源码、文档内容、随主题分发的第三方资源。三者各自的许可证不会被重新授权成一份统一作品。下面每张表都指向仓库里的权威文件,摘要与许可证原文不一致时以文件为准

许可证对应关系

范围许可证权威文件
OINK 主题源码(布局、partial、 shortcode、SCSS、JS、i18n)Apache License 2.0主题 LICENSENOTICE
本站的站点代码、构建脚本与源自 Docsy 的材料Apache License 2.0站点 LICENSENOTICE
本站的原创文档内容(另有声明的除外)Creative Commons Attribution 4.0 International站点 LICENSE-CC-BY-4.0
随主题分发的浏览器库、字体与图标各组件自己的许可证主题 VENDOR.json 与资源旁的许可证文件

两条边界要分清:CC BY 4.0 只覆盖原创文档内容,不覆盖主题代码、商标、截图与第三方资源;主题采用 Apache-2.0,也不会把随附依赖变成 Apache 许可的作品。

上游:Docsy

主题 NOTICE 记录的事实:

  • OINK 派生自 Docsy,Copyright 2018 Google LLC and Docsy contributors。
  • OINK 自身的主题工作 Copyright 2026 PGSTY contributors。
  • 项目与上游同为 Apache License 2.0;第三方浏览器依赖的许可、来源、版本与校验值记录在 VENDOR.json,各自要求的 NOTICE 文件与对应资源放在一起分发。
  • Docsy 名称与 Google 商标归各自权利人所有,此处引用只用于标识上游项目,不表示背书

本站也派生自 Docsy 项目网站,这段渊源记录在站点自己的 NOTICE 里。Docsy 是 OINK 唯一的代码上游:源码历史、Apache-2.0 义务与版权声明完整保留,按 Apache-2.0 的要求,修改过的文件需要标注。

随主题分发的第三方运行时

主题把浏览器要用的资源全部提交在仓库里(assets/third_party/assets/js/third_party/static/webfonts/),消费站点不需要 npm,也不会在构建期下载任何东西。VENDOR.json 是这批资源的机器可读清单,逐项记录名称、固定版本、来源 URL、许可证文件路径,以及每个选取产物的 SHA-256;清单里还有三棵资源目录的整体校验值。

下表是清单快照(VENDOR.json 生成于 2026-08-17,schema 1,共 26 项)。版本会随主题发布变动,以仓库里的 VENDOR.json 为准。全部来源都是 npm registry(https://registry.npmjs.org/…)。

项目版本许可证在主题里做什么
bootstrap5.3.8MIT栅格、组件与 RTL 样式基础
@popperjs/core2.11.8MITBootstrap 的浮层定位
@fortawesome/fontawesome-free7.3.1CC-BY-4.0 AND OFL-1.1 AND MIT全站图标
@fontsource-variable/inter5.3.0OFL-1.1界面与正文字体
@fontsource/chakra-petch5.3.0OFL-1.1品牌展示字体
@fontsource/ibm-plex-mono5.3.0OFL-1.1代码字体
lunr2.3.9MIT本地全文检索
@docsearch/js5.0.1MIT可选的 Algolia DocSearch 前端
@docsearch/css5.0.1MIT同上的样式
mermaid11.16.1MITMermaid 图表
katex0.18.4MIT数学公式
markmap-autoloader0.18.12MIT思维导图
markmap-lib0.18.12MIT思维导图
markmap-view0.18.12MIT思维导图
markmap-toolbar0.18.12MIT思维导图工具条
d37.9.0ISCMarkmap 依赖
@highlightjs/cdn-assets11.12.0BSD-3-ClauseMarkmap 依赖
webfontloader1.6.28Apache-2.0Markmap 依赖
swagger-ui-dist5.32.13Apache-2.0OpenAPI 文档页
redoc2.5.3MITOpenAPI 文档页
asciinema-player3.17.0Apache-2.0终端录像回放
echarts6.1.0Apache-2.0图表
@antv/infographic0.2.19MIT信息图
pako3.0.1MIT AND Zlib解压(图表数据)
external-svg-loader1.7.1MIT内联外部 SVG
idb-keyval6.2.0Apache-2.0浏览器端缓存

许可证原文与各资源放在一起:例如 assets/third_party/bootstrap/LICENSEassets/third_party/katex/LICENSE;Swagger UI、Redoc 与 ECharts 还随包带了各自的 NOTICE 或打包声明文件。Lunr 是唯一的例外,代码在 assets/js/third_party/,许可证在 assets/third_party/lunr/LICENSE

再分发主题时,这些许可与声明材料必须一并保留。更新某个运行时意味着在同一次变更里同时更新产物、许可证文件、来源与校验值。

字体与图标

三款字体(Inter、Chakra Petch、IBM Plex Mono)都采用 SIL Open Font License 1.1,字体文件提交在 static/webfonts/:Inter 十四个子集文件、品牌字体四个,加上 Font Awesome 的三个,共二十一个。Font Awesome Free 7.3.1 是复合许可:图标图形 CC BY 4.0、字体文件 SIL OFL 1.1、代码 MIT,原文在 assets/third_party/Font-Awesome/LICENSE.txt

主题不向远程字体服务发请求:仓库里没有 Google Fonts 之类的外链,字体一律由站点自身 baseURL 下发。更换字体或改用系统字体栈见品牌外观

设计参考

代码上游只有 Docsy 一个。下面这些项目是设计语言上的参考,既不是代码来源也不是运行时依赖,OINK 没有移植它们的代码:

项目借鉴之处
Fumadocs以内容为中心的呈现、信息层级、文件树与参数表一类的写作组件(主题 NOTICE 记录了这条致敬)
Nextra精炼的文档外壳、代码块的文件名与复制交互、按页布局开关
HextraHugo 原生的实现取向、文件树、徽章、标签页
Mintlify结构化导航分层、同步的代码分组、API 参考的阅读体验

Hugo 是构建平台,Go 在 Hugo Module 安装方式下负责解析模块。两者都是前提条件,主题不重新分发它们的可执行文件。

引用这些名字用于说明传承、依赖或灵感来源,不表示相关项目为 OINK 背书;各项目与产品名称归其权利人所有。

复用这份文档

CC BY 4.0 允许任何目的的分享与演绎,条件是给出署名、提供许可证链接、说明是否做过修改,并且不得暗示 OINK、PGSTY 或上游项目为改编内容背书。一段合格的署名可以是:

本文改编自 PGSTY 贡献者编写的 OINK 文档,采用 CC BY 4.0 许可,并做了修改。

页面里单独署名的图片或引文,要保留它们各自的署名与许可;删掉页脚不会免除署名义务。

复用这个主题

Apache-2.0 允许按条款使用、修改与分发主题源码及编译产物,条件是保留许可证、版权与归属声明,保留 NOTICE 内容,并在分发修改后的源码时标明改过哪些文件。主题发行包应当包含 LICENSENOTICEVENDOR.json,以及清单引用的全部第三方许可证文件。

Apache-2.0 不授予商标使用权,也不会把第三方资源变成 Apache 许可的作品。