文档 撰写者工具包 结构 文档设计

关于 Grafana Labs 的文档设计

我们的文档网站采用现代设计方法，旨在使技术文档易于访问且可伸缩。

文档网站使用静态站点生成器 Hugo。页面上的许多元素在页面发布过程中通过 Hugo 的分类法自动管理。因此，源 Markdown 文件无需手动管理这些元素，也无需贡献者去整理它们。

页面包括

• 预览主要主题的导航。 左侧边栏广泛概述了关键主题，下方嵌套了相关主题。这种设计支持“每一页都是第一页”的理念，并围绕一个主题创建了一个更易于参考和导航的文档系统。
• 浮动目录。 目录在您向下滚动查看折叠下方内容时会浮动在页面上。您还可以查看即将到来的主题，从而提供更好的用户体验，帮助您导航到页面下方的小节。
• 自动生成的相关文档。 使用 Hugo 的分类法，文档会自动查找与您正在查看的页面相关的其他文档。
• 自动生成的来自 Grafana Labs 的相关资源。 Hugo 的分类法再次自动生成此内容。
• 反馈。 点赞和点踩反馈。

您可以在以下文章中了解我们文档页面的重新设计：Grafana 文档：新设计和改进设计的介绍。