分类: 配置

  • 代码仓库链接与页面信息

    分类:

    OINK 的文档与博客布局可以显示指向当前页面源码仓库的链接。它们位于面包屑行末尾的页面操作菜单中： 查阅 Markdown 源码：当启用 Markdown 输出时，打开生成的 Markdown 备用版本。 查阅编辑历史：打开源文件的提交历史。 编辑本页：打开可编辑的源码视图。 创建子页面：在当前页面下新建文件，并可使用站点的 assets/stubs/new-page-template.md 模板。 创建文档 issue：携带页面上下文，在文档仓库中创建 issue。 创建项目 issue：可 …

    OINK 的文档与博客布局可以显示指向当前页面源码仓库的链接。它们位于面包屑行末尾的页面操作菜单中： 查阅 Markdown 源码：当启用 Markdown 输出时，打开生成的 Markdown 备用版本。 查阅编辑历史：打开源文件的提交历史。 编辑本页：打开可编辑的源码视图。 创建子页面：在当前页面下新建文件，并可使用站点的 assets/stubs/new-page-template.md 模板。 创建文档 issue：携带页面上下文，在文档仓库中创建 issue。 创建项目 issue：可 …

  • 版本管理

    分类:

    产品有多个受支持版本时，文档通常也要分版本。OINK 提供两样东西：版本切换菜单和归档版本横幅。 各版本具体怎么部署由你决定——常见做法是每个版本一个子域名或子路径，各自独立构建。 版本切换菜单 在 params.versions 中列出要出现在菜单里的版本： hugo.yaml YAML params: version_menu: v2.1 versions: - version: v2.1 url: https://docs.example.com - version: v2.0 url: …

    产品有多个受支持版本时，文档通常也要分版本。OINK 提供两样东西：版本切换菜单和归档版本横幅。 各版本具体怎么部署由你决定——常见做法是每个版本一个子域名或子路径，各自独立构建。 版本切换菜单 在 params.versions 中列出要出现在菜单里的版本： hugo.yaml YAML params: version_menu: v2.1 versions: - version: v2.1 url: https://docs.example.com - version: v2.0 url: …

  • 多语言

    分类:

    OINK 直接使用 Hugo 的多语言页面模型，不引入站点专属的域名约定或模板假设。本站以英文为首要语言、简体中文（zh）为第二语言。 配置语言 hugo.yaml YAML defaultContentLanguage: en languages: en: label: English locale: en-US weight: 1 title: Product Documentation params: description: Product guides and reference …

    OINK 直接使用 Hugo 的多语言页面模型，不引入站点专属的域名约定或模板假设。本站以英文为首要语言、简体中文（zh）为第二语言。 配置语言 hugo.yaml YAML defaultContentLanguage: en languages: en: label: English locale: en-US weight: 1 title: Product Documentation params: description: Product guides and reference …

  • 站点配置

    分类:

    站点跑起来之后，这一章处理站点级的结构性配置：读者怎么导航、内容有几种语言、文档有几个版本、页面操作指向哪个仓库。 具体页面的写法见创作内容，可用组件见组件参考。 本章内容 配置总览：hugo.yaml 的完整参数面 导航与菜单：顶部菜单、侧栏、面包屑 多语言：语言路由、译文回退、RTL 版本管理：多版本文档与版本切换 仓库链接：编辑、历史、报告问题等页面操作的来源

    站点跑起来之后，这一章处理站点级的结构性配置：读者怎么导航、内容有几种语言、文档有几个版本、页面操作指向哪个仓库。 具体页面的写法见创作内容，可用组件见组件参考。 本章内容 配置总览：hugo.yaml 的完整参数面 导航与菜单：顶部菜单、侧栏、面包屑 多语言：语言路由、译文回退、RTL 版本管理：多版本文档与版本切换 仓库链接：编辑、历史、报告问题等页面操作的来源

  • 导航与菜单

    分类:

    OINK 把 Hugo 的内容树和菜单模型组织成一套文档工作台：出现在所有布局上的站点导航栏、可折叠且可调整宽度的分区侧边栏、位于右栏的可折叠页面大纲，以及站点页脚。同一套结构适用于英文、中文和从右向左书写的语言。 站点导航栏 导航栏由 Hugo 的 main 菜单与 OINK 自动生成的控件组成：版本选择器、语言选择器、颜色模式控件、搜索，以及项目仓库链接。它会在所有布局上渲染——落地页、文档、博客、Swagger 和分类页面都不例外，因此站点级导航在任何位置都只有一次点击的距离。 关闭导航栏 …

    OINK 把 Hugo 的内容树和菜单模型组织成一套文档工作台：出现在所有布局上的站点导航栏、可折叠且可调整宽度的分区侧边栏、位于右栏的可折叠页面大纲，以及站点页脚。同一套结构适用于英文、中文和从右向左书写的语言。 站点导航栏 导航栏由 Hugo 的 main 菜单与 OINK 自动生成的控件组成：版本选择器、语言选择器、颜色模式控件、搜索，以及项目仓库链接。它会在所有布局上渲染——落地页、文档、博客、Swagger 和分类页面都不例外，因此站点级导航在任何位置都只有一次点击的距离。 关闭导航栏 …

  • 配置

    分类:

    OINK 遵循“原生优先”的配置模型。站点身份、语言、菜单、输出、taxonomy、标记与模块继续放在 Hugo 规定的位置；语义仍然适用的 Docsy 参数也保持原位。只有无法可靠推导的行为选择，OINK 才会增加职责明确的配置。 配置原则 优先使用 Hugo 配置，不创建主题专用的重复项。 优先使用成熟的 Docsy 参数，不另造 OINK 同义词。 品牌、内容、仓库与 UI 选项应放在各自语义位置。 内部 vendor 路径与模板组装方式不属于公开 API。 遇到非法值或缺少必需端点时，应 …

    OINK 遵循“原生优先”的配置模型。站点身份、语言、菜单、输出、taxonomy、标记与模块继续放在 Hugo 规定的位置；语义仍然适用的 Docsy 参数也保持原位。只有无法可靠推导的行为选择，OINK 才会增加职责明确的配置。 配置原则 优先使用 Hugo 配置，不创建主题专用的重复项。 优先使用成熟的 Docsy 参数，不另造 OINK 同义词。 品牌、内容、仓库与 UI 选项应放在各自语义位置。 内部 vendor 路径与模板组装方式不属于公开 API。 遇到非法值或缺少必需端点时，应 …