分类: 内容
-
Logo 与图片
分类:添加品牌标识 Oink 默认使用 assets/icons/logo.svg 作为品牌图标。通过 params.logo 可以替换它；如果页头应显示完整字标，而不是“图标 + 站点标题”，则设置 params.wordmark： YAML params: logo: icons/product.svg wordmark: images/product-wordmark.svg 两个参数都可以指向 Hugo asset 或公开路径。需要主题处理的文件优先放入 assets/；必须原样复制的文件放入 …
添加品牌标识 Oink 默认使用 assets/icons/logo.svg 作为品牌图标。通过 params.logo 可以替换它；如果页头应显示完整字标，而不是“图标 + 站点标题”，则设置 params.wordmark： YAML params: logo: icons/product.svg wordmark: images/product-wordmark.svg 两个参数都可以指向 Hugo asset 或公开路径。需要主题处理的文件优先放入 assets/；必须原样复制的文件放入 …
-
Hugo 内容技巧
分类:Oink 是一款 Hugo 主题，因此普通 Markdown 与 Hugo 内容模型仍是创作基础。遵循以下约定，可以让页面在翻译、重组或部署到子路径后继续保持清晰与稳定。 链接到发布后的路由 面向读者的链接应指向规范发布 URL，而不是相邻源码文件路径。/zh/docs/content/ 这样的根相对链接便于全站审计。如果链接需要在源码移动后继续跟随目标页面，可以使用 Hugo 的 ref 或 relref 短代码： MARKDOWN [站点配置]({{< ref …
Oink 是一款 Hugo 主题，因此普通 Markdown 与 Hugo 内容模型仍是创作基础。遵循以下约定，可以让页面在翻译、重组或部署到子路径后继续保持清晰与稳定。 链接到发布后的路由 面向读者的链接应指向规范发布 URL，而不是相邻源码文件路径。/zh/docs/content/ 这样的根相对链接便于全站审计。如果链接需要在源码移动后继续跟随目标页面，可以使用 Hugo 的 ref 或 relref 短代码： MARKDOWN [站点配置]({{< ref …
-
组织内容
分类:Oink 根据 Hugo 内容树生成文档侧栏，因此目录结构也是读者体验的一部分，而不只是源码组织细节。先明确读者需要解决的问题，再建立能够快速找到答案的最小层级。 从读者目标出发 为新读者提供一条从产品背景到首次成功操作的短路径；为回访读者提供直达操作指南、参考资料与故障排查的入口。一套实用文档通常需要： 说明范围与产品边界的概览； 能得到可运行结果的快速上手路径； 围绕常见工作的任务指南； 参数、API 与兼容性的参考页面； 覆盖常见故障的诊断与恢复说明。 当示例能够直接复制或对比时，它们很有 …
Oink 根据 Hugo 内容树生成文档侧栏，因此目录结构也是读者体验的一部分，而不只是源码组织细节。先明确读者需要解决的问题，再建立能够快速找到答案的最小层级。 从读者目标出发 为新读者提供一条从产品背景到首次成功操作的短路径；为回访读者提供直达操作指南、参考资料与故障排查的入口。一套实用文档通常需要： 说明范围与产品边界的概览； 能得到可运行结果的快速上手路径； 围绕常见工作的任务指南； 参数、API 与兼容性的参考页面； 覆盖常见故障的诊断与恢复说明。 当示例能够直接复制或对比时，它们很有 …