内容组织
此网站使用 Hugo。在 Hugo 中,内容组织 是一个核心概念。
注意
Hugo 提示:使用hugo server --navigateToChanged
启动 Hugo,以进行内容编辑会话。页面列表
页面顺序
文档侧边栏菜单、文档页面浏览器等使用 Hugo 的默认排序顺序列出,该顺序按权重(从 1 开始)、日期(最新优先)和链接标题排序。
因此,如果要向上移动页面或部分,请在页面的前置 matter 中设置权重
title: My Page
weight: 10
注意
对于页面权重,使用 1、2、3 ... 而不是其他间隔,例如 10、20、30 ... 这允许您在需要时插入页面。此外,同一个目录(部分)内的每个权重不应与其他权重重叠。这确保内容始终正确组织,尤其是在本地化内容中。文档主菜单
Documentation
主菜单构建自 docs/
下面的部分,并在 _index.md
部分内容文件的前置 matter 中设置 main_menu
标志。
main_menu: true
请注意,链接标题是从页面的 linkTitle
中获取的,因此,如果您想将其更改为与标题不同的内容,请在内容文件中进行更改。
main_menu: true
title: Page Title
linkTitle: Title used in links
注意
上述操作需要针对每种语言进行。如果您在菜单中没有看到您的部分,可能是因为 Hugo 没有将其识别为部分。在部分文件夹中创建一个_index.md
内容文件。文档侧边栏菜单
文档侧边栏菜单构建自 docs/
下面开始的*当前部分树*。
它将显示所有部分及其页面。
如果您不想列出某个部分或页面,请在前置 matter 中将 toc_hide
标志设置为 true
toc_hide: true
当您导航到包含内容的部分时,将显示特定部分或页面(例如 _index.md
)。否则,将显示该部分内的第一个页面。
文档浏览器
文档主页上的页面浏览器使用 docs 部分
下面的所有部分和页面构建。
如果您不想列出某个部分或页面,请在前置 matter 中将 toc_hide
标志设置为 true
toc_hide: true
主菜单
右上角菜单(以及页脚)中的网站链接通过页面查找构建。这样做是为了确保页面确实存在。因此,如果某个网站(语言)中不存在 case-studies
部分,则不会链接到该部分。
页面捆绑包
除了独立的内容页面(Markdown 文件)外,Hugo 还支持 页面捆绑包。
一个示例是 自定义 Hugo 短代码。它被视为 叶捆绑包
。目录下的一切,包括 index.md
,都将成为捆绑包的一部分。这也包括页面相对链接、可以处理的图像等。
en/docs/home/contribute/includes
├── example1.md
├── example2.md
├── index.md
└── podtemplate.json
另一个广泛使用的示例是 includes
捆绑包。它在前置 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 所谓的
资源
,您可以针对每种语言提供元数据,例如参数和标题,即使它不支持前置 matter(YAML 文件等)。请参见 页面资源元数据。 - 从
资源
的.RelPermalink
中获得的值是页面相对的。请参见 永久链接。
样式
此网站样式表的 SASS 源代码存储在 assets/sass
中,并由 Hugo 自动构建。
下一步
- 了解 自定义 Hugo 短代码
- 了解 风格指南
- 了解 内容指南