内容组织
本站点使用 Hugo。在 Hugo 中,内容组织 是一个核心概念。
注意
Hugo 提示: 使用hugo server --navigateToChanged
启动 Hugo 进行内容编辑。页面列表
页面顺序
文档侧边菜单、文档页面浏览器等使用 Hugo 的默认排序顺序列出,该顺序按权重(从 1 开始)、日期(最新优先)以及最后的链接标题进行排序。
鉴于此,如果您想向上移动页面或部分,请在页面的 front matter 中设置权重
title: My Page
weight: 10
注意
对于页面权重,最好不要使用 1、2、3 ...,而是使用其他间隔,例如 10、20、30... 这允许您稍后在需要的位置插入页面。此外,同一目录(部分)内的每个权重不应与其他权重重叠。这确保内容始终正确组织,尤其是在本地化内容中。文档主菜单
文档
主菜单由 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
部分,则不会链接到它。
页面包
除了独立的内容页面(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 所谓的
资源
,您可以为每种语言提供元数据,例如参数和标题,即使它不支持 front matter(YAML 文件等)。请参阅 页面资源元数据。 - 从
Resource
的.RelPermalink
获取的值是页面相对的。请参阅 永久链接。
样式
本站点的样式表的 SASS 源代码存储在 assets/sass
中,并由 Hugo 自动构建。
下一步是什么
- 了解 自定义 Hugo shortcodes
- 了解 风格指南
- 了解 内容指南