内容组织

本站点使用 Hugo。在 Hugo 中，内容组织 是一个核心概念。

页面列表

页面排序

文档侧边菜单、文档页面浏览器等使用 Hugo 的默认排序顺序进行列表显示，该顺序按权重（从 1 开始）、日期（最新优先），最后按链接标题排序。

基于此，如果你想将页面或部分上移，请在页面的 front matter 中设置权重。

title: My Page
weight: 10

文档主菜单

Documentation 主菜单是根据 docs/ 下方在 _index.md 部分内容文件的 front matter 中设置了 main_menu 标志的部分构建的。

main_menu: true

请注意，链接标题是从页面的 linkTitle 获取的，因此如果你想让它与页面标题不同，请在内容文件中进行修改。

main_menu: true
title: Page Title
linkTitle: Title used in links

文档侧边菜单

文档侧边栏菜单是根据从 docs/ 开始的当前部分树构建的。

它将显示所有部分及其页面。

如果你不想列出某个部分或页面，请在 front matter 中将 toc_hide 标志设置为 true。

toc_hide: true

当你导航到具有内容的部分时，会显示特定的部分或页面（例如 _index.md）。否则，将显示该部分内的第一个页面。

文档浏览器

文档主页上的页面浏览器是使用直接位于 docs 部分 下方的所有部分和页面构建的。

如果你不想列出某个部分或页面，请在 front matter 中将 toc_hide 标志设置为 true。

toc_hide: true

主菜单

右上角菜单以及页脚中的站点链接是通过页面查找构建的。这是为了确保页面实际存在。因此，如果某个站点（语言）中不存在 case-studies 部分，则不会链接到它。

页面包

除了独立的内容页面（Markdown 文件）之外，Hugo 还支持 页面包。

一个示例是 定制 Hugo Shortcodes。它被视为一个 leaf bundle（叶子包）。目录下的所有内容，包括 index.md，都将成为包的一部分。这也包括页面相对链接、可处理的图像等。

en/docs/home/contribute/includes
├── example1.md
├── example2.md
├── index.md
└── podtemplate.json

另一个广泛使用的示例是 includes 包。它在 front matter 中设置 headless: true，这意味着它没有自己的 URL。它仅在其他页面中使用。

en/includes
├── default-storage-class-prereqs.md
├── index.md
├── partner-script.js
├── partner-style.css
├── task-tutorial-prereqs.md
├── user-guide-content-moved.md
└── user-guide-migration-notice.md

包中文件的一些重要注意事项

  • 对于已翻译的包，任何缺失的非内容文件将从上层语言继承。这避免了重复。
  • 包中的所有文件都是 Hugo 所称的 Resources，你可以按语言为它们提供元数据，例如参数和标题，即使它们不支持 front matter（YAML 文件等）。请参阅 页面资源元数据。
  • 从 Resource 的 .RelPermalink 获得的值是相对于页面的。请参阅 固定链接。

样式

本站点的样式表的 SASS 源文件存储在 assets/sass 中，并由 Hugo 自动构建。

下一步

最后修改于 2023 年 6 月 1 日太平洋时间 9:43 PM：修改 content-organization.md 中的行换行 (1ec7fe8e63)