内容组织

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

说明： Hugo 提示： 用 hugo server --navigateToChanged 命令启动 Hugo 以进行内容编辑会话。

页面列表

页面顺序

文档侧方菜单、文档页面浏览器等以 Hugo 的默认排序顺序列出。Hugo 会按照权重（从 1 开始）、 日期（最新的排最前面）排序，最后按链接标题排序。

有鉴于此，如果你想将一个页面或一个章节前移，请在页面头部设置一个较高的权重：

  1. title: My Page
  2. weight: 10

说明： 对于页面的权重，不建议使用连续的数值，比如1、2、3…，而应采用间隔的数值，比如10、20、30… 这样将来你可以将其他页面插入到想要的位置。

文档主菜单

文档 主菜单是从 docs/ 下面的章节构建的。 这些章节在其章节内容文件 _index.md 的头部设置了 main_menu 标志：

  1. main_menu: true

注意，链接标题来自页面的 linkTitle 字段，因此如果希望它与页面标题不同，请在内容文件中更改它：

  1. main_menu: true
  2. title: Page Title
  3. linkTitle: Title used in links

说明： 以上操作需要为每种语言分别完成。如果在菜单中没有看到你的章节，这可能是因为它没有被 Hugo 识别为一个章节。 请在章节对应的目录下创建 _index.md 内容文件。

文档侧方菜单

文档侧方菜单是基于 docs/ 下面的 当前章节的内容树 构建的。

菜单默认显示所有的章节和它们的页面。

如果你不想列出某个章节或页面，请在页面头部将 toc_hide 标志设置为 true。

  1. toc_hide: true

当导航到具有内容的章节时，网站将显示出指定的章节或页面（例如 _index.md）。 否则，将显示该章节里的第一个页面。

文档浏览器

文档主页上的页面浏览器是基于 docs section 下一层的所有章节和页面构建的。

如果你不想列出某个章节或页面，请在页面头部将 toc_hide 标志设置为 true。

  1. toc_hide: true

主菜单

右上菜单中的网站链接（也出现在页脚中）是通过页面查找构建的。 这是为了确保页面实际存在。因此，如果 case-studies 章节在网站（或者其本地化版本）中不存在， 则不会出现对应的链接。

页面包

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

一个例子是定制的 Hugo 短代码（shortcodes）。 它被认为是 leaf bundle（叶子包）。 目录下的所有内容，包括 index.md，都是包的一部分。此外还包括页面间相对链接、可被处理的图像等：

  1. en/docs/home/contribute/includes
  2. ├── example1.md
  3. ├── example2.md
  4. ├── index.md
  5. └── podtemplate.json

另一个广泛使用的例子是 includes 包。 这类包在页面头部设置 headless: true，意味着它没有得到自己的 URL。它只用于其他页面。

  1. en/includes
  2. ├── default-storage-class-prereqs.md
  3. ├── index.md
  4. ├── partner-script.js
  5. ├── partner-style.css
  6. ├── task-tutorial-prereqs.md
  7. ├── user-guide-content-moved.md
  8. └── user-guide-migration-notice.md

有关包中文件的一些重要说明：

  • 已翻译的包会从上面的语言继承所有缺失的、非内容文件。这一设计可以避免重复。
  • 包中的所有文件都是 Hugo 所指的 Resources，你可以为用不同语言为其提供元数据， 例如参数和标题，即使它不支持头部设置（YAML 文件等）。 参见页面资源元数据。
  • 从 Resource 的 .RelPermalink 中获得的值是相对于当前页面的。 参见 Permalinks。

样式

网站的样式表的 SASS 源文件存储在 src/sass 下面，可以用 make sass 构建 （Hugo 很快就提供 SASS 的支持，参见 https://github.com/gohugoio/hugo/issues/4243）。

接下来

最后修改 October 10, 2020 at 2:51 PM PST : [zh] Resync federation content cleanup (4d0f4309a)