分类: 关于

  • 关于 Oink

    分类:

    OINK 把 Markdown、配置与本地资源转换成完整的技术文档站。站点取得主题源码并安装 Hugo Extended 后，无需维护前端工具链，即可构建文档、博客、多语言导航、本地搜索、图表、API 参考与可复用内容组件。 Oink 提供什么 能力 主题契约 文档与博客布局 响应式导航、面包屑导航、目录、页面元数据、反馈、打印与索引 多语言行为 译文路由、语言元数据、稳定锚点与分语言本地搜索 本地优先浏览器功能 固定版本的样式、字体、搜索、图表、API 参考、录像与信息图 内容组件 标签页、折 …

    OINK 把 Markdown、配置与本地资源转换成完整的技术文档站。站点取得主题源码并安装 Hugo Extended 后，无需维护前端工具链，即可构建文档、博客、多语言导航、本地搜索、图表、API 参考与可复用内容组件。 Oink 提供什么 能力 主题契约 文档与博客布局 响应式导航、面包屑导航、目录、页面元数据、反馈、打印与索引 多语言行为 译文路由、语言元数据、稳定锚点与分语言本地搜索 本地优先浏览器功能 固定版本的样式、字体、搜索、图表、API 参考、录像与信息图 内容组件 标签页、折 …

  • 开源许可与致谢

    分类:

    OINK 由采用 Apache 许可证的主题、单独授权的文档站，以及各自保留许可证的第三方组件组成。这些层次不会被重新授权成一份不加区分的作品。 本页用于帮助工程维护者理解来源，不代替许可证原文。如果摘要与许可证文件存在差异，以许可证文件为准。 许可证对应关系 范围 许可证 权威记录 Oink 主题源码与 Oink 的主题改动 Apache License 2.0 主题 LICENSE 与 NOTICE 站点代码、构建工具与源自 Docsy 的材料 Apache License 2.0 站点 …

    OINK 由采用 Apache 许可证的主题、单独授权的文档站，以及各自保留许可证的第三方组件组成。这些层次不会被重新授权成一份不加区分的作品。 本页用于帮助工程维护者理解来源，不代替许可证原文。如果摘要与许可证文件存在差异，以许可证文件为准。 许可证对应关系 范围 许可证 权威记录 Oink 主题源码与 Oink 的主题改动 Apache License 2.0 主题 LICENSE 与 NOTICE 站点代码、构建工具与源自 Docsy 的材料 Apache License 2.0 站点 …

  • 贡献指南

    分类:

    OINK 是从 Docsy 派生的独立主题。贡献必须保留 Apache-2.0 历史和适用的第三方 NOTICE，同时改进唯一的标准实现。 提交变更之前 在 OINK 仓库中搜索已有 issue 和拉取请求。 报告缺陷时，请记录 Hugo 版本、安装方式、语言、路由、生产命令和最小可复现输入。 提议功能时，请说明它为什么属于可复用主题，而不是消费站点的业务层。 不要引入 oink.enabled 开关、oink.* 配置树或平行视觉外壳。OINK 的标准布局就是产品本身。 小型修复可以直接实现。 …

    OINK 是从 Docsy 派生的独立主题。贡献必须保留 Apache-2.0 历史和适用的第三方 NOTICE，同时改进唯一的标准实现。 提交变更之前 在 OINK 仓库中搜索已有 issue 和拉取请求。 报告缺陷时，请记录 Hugo 版本、安装方式、语言、路由、生产命令和最小可复现输入。 提议功能时，请说明它为什么属于可复用主题，而不是消费站点的业务层。 不要引入 oink.enabled 开关、oink.* 配置树或平行视觉外壳。OINK 的标准布局就是产品本身。 小型修复可以直接实现。 …

  • 架构

    分类:

    Oink 是一款直接运行于 Hugo 的主题，而不是应用服务器，也不是套在 Docsy 外面的运行时包装层。Hugo 在构建阶段解析内容、配置、布局与资源，再生成可由普通文件托管服务发布的静态站点。 系统边界 flowchart LR C[站点内容] --> H[Hugo Extended] G[Hugo 配置] --> H T[Oink Hugo Module] --> H V[已提交的第三方资源] --> T H --> P[静态 public 目录] P --> B[浏览器] 消费端边界始 …

    Oink 是一款直接运行于 Hugo 的主题，而不是应用服务器，也不是套在 Docsy 外面的运行时包装层。Hugo 在构建阶段解析内容、配置、布局与资源，再生成可由普通文件托管服务发布的静态站点。 系统边界 flowchart LR C[站点内容] --> H[Hugo Extended] G[Hugo 配置] --> H T[Oink Hugo Module] --> H V[已提交的第三方资源] --> T H --> P[静态 public 目录] P --> B[浏览器] 消费端边界始 …

  • 本地优先运行

    分类:

    OINK 的本地优先原则很简单：由主题提供的功能，不得暗中依赖公共 CDN、构建期下载或未经配置的公共服务。完整发行包能够在网络隔离环境中构建，其核心页面也能在该环境中浏览。 本地优先覆盖的范围 主题会从生成后的站点提供以下依赖： 能力 本地交付方式 页面外壳与响应式界面 Bootstrap 与 OINK CSS/JavaScript 图标与字体 Font Awesome、Open Sans、Chakra Petch、IBM Plex Mono 搜索 Lunr、CJK 子串回退与按语言生成的索引 …

    OINK 的本地优先原则很简单：由主题提供的功能，不得暗中依赖公共 CDN、构建期下载或未经配置的公共服务。完整发行包能够在网络隔离环境中构建，其核心页面也能在该环境中浏览。 本地优先覆盖的范围 主题会从生成后的站点提供以下依赖： 能力 本地交付方式 页面外壳与响应式界面 Bootstrap 与 OINK CSS/JavaScript 图标与字体 Font Awesome、Open Sans、Chakra Petch、IBM Plex Mono 搜索 Lunr、CJK 子串回退与按语言生成的索引 …

  • 示例站点

    分类:

    OINK 提供三种不同规模的示例。请选用足以回答当前问题的最小示例：完整项目站适合回归验证，但它有意包含比普通消费站点更多的内容。 选择合适的示例 示例 最适合验证的内容 仓库或指南 双语项目站 生产规模的配置与质量检查 pgsty/oink.pgsty.com 主题 exampleSite/ 落地页组合与主题 checkout pgsty/oink/exampleSite 最小双语消费站点 从零新建文档站 从零新建站点 双语项目站 pgsty/oink.pgsty.com 是你正在阅读的完整文 …

    OINK 提供三种不同规模的示例。请选用足以回答当前问题的最小示例：完整项目站适合回归验证，但它有意包含比普通消费站点更多的内容。 选择合适的示例 示例 最适合验证的内容 仓库或指南 双语项目站 生产规模的配置与质量检查 pgsty/oink.pgsty.com 主题 exampleSite/ 落地页组合与主题 checkout pgsty/oink/exampleSite 最小双语消费站点 从零新建文档站 从零新建站点 双语项目站 pgsty/oink.pgsty.com 是你正在阅读的完整文 …