内容组织
本站使用 Hugo。在 Hugo 中,内容组织是一个核心概念。
注意
Hugo 提示: 使用hugo server --navigateToChanged
启动 Hugo 以进行内容编辑会话。页面列表
页面顺序
文档侧边菜单、文档页面浏览器等列表使用 Hugo 的默认排序顺序,即按权重(从 1 开始)、日期(最新在前)排序,最后按链接标题排序。
鉴于此,如果您想将页面或部分向上移动,请在页面的 front matter 中设置一个权重。
title: My Page
weight: 10
注意
对于页面权重,最好不要使用 1、2、3...,而是使用其他间隔,例如 10、20、30...。这样您以后就可以在需要时插入页面。此外,同一目录(部分)内的每个权重都不应与其他权重重叠。这可以确保内容始终正确组织,尤其是在本地化内容中。文档主菜单
Documentation
主菜单由 docs/
下的各个部分构建,这些部分的 _index.md
内容文件 front matter 中设置了 main_menu
标志。
main_menu: true
请注意,链接标题是从页面的 linkTitle
中获取的,因此如果您希望它与标题不同,请在内容文件中进行更改。
main_menu: true
title: Page Title
linkTitle: Title used in links
注意
以上操作需要按语言分别进行。如果您未在菜单中看到您的部分,可能是因为它未被 Hugo 识别为一部分。请在部分文件夹中创建一个_index.md
内容文件。文档侧边菜单
文档侧边栏菜单由 docs/
下方的当前部分树构建。
它将显示所有部分及其页面。
如果您不想列出某个部分或页面,请在 front matter 中将 toc_hide
标志设置为 true
。
toc_hide: true
当您导航到一个有内容的节时,将显示该特定节或页面(例如 _index.md
)。否则,将显示该节内的第一个页面。
文档浏览器
文档主页上的页面浏览器使用 docs
部分下方的所有部分和页面来构建。
如果您不想列出某个部分或页面,请在 front matter 中将 toc_hide
标志设置为 true
。
toc_hide: true
主菜单
右上角菜单(以及页脚)中的站点链接是通过页面查找构建的。这是为了确保页面实际存在。因此,如果某个站点(语言)不存在 case-studies
部分,它将不会被链接。
页面包
除了独立的 Content Pages(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 自动构建。
下一步
- 了解 自定义 Hugo Shortcodes
- 了解 样式指南
- 了解 内容指南