HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
TEMPLATES

站点地图模板

Hugo 提供内置的站点地图模板。

概述

Hugo 的嵌入式站点地图模板符合 站点地图协议 的 v0.9 版本。

对于单语言项目,Hugo 使用 嵌入式站点地图模板 在 publishDir 的根目录下生成一个 sitemap.xml 文件。

对于多语言项目,Hugo 会生成:

  • 使用 嵌入式站点地图模板 在每个站点(语言)的根目录下生成一个 sitemap.xml 文件。
  • 使用 嵌入式站点地图索引模板 在 publishDir 的根目录下生成一个 sitemap.xml 文件。

配置

这些是站点地图的默认配置值。除非在 front matter 中被覆盖,否则它们适用于所有页面。

hugo.
     
sitemap:
  changeFreq: ""
  disable: false
  filename: sitemap.xml
  priority: -1
[sitemap]
  changeFreq = ''
  disable = false
  filename = 'sitemap.xml'
  priority = -1
{
   "sitemap": {
      "changeFreq": "",
      "disable": false,
      "filename": "sitemap.xml",
      "priority": -1
   }
}
changefreq
(string) 页面更改的频率。有效值为 always 、 hourly 、 daily 、 weekly 、 monthly 、 yearly 和 never 。使用默认值 "" 时,Hugo 将省略站点地图中的此字段。参见 详情 。
disable New in v0.125.0
(bool) 是否禁用页面包含。默认为 false 。在 front matter 中设置为 true 以排除页面。
filename
(string) 生成的文件名。默认为 sitemap.xml 。
priority
(float) 页面相对于站点上任何其他页面的优先级。有效值范围为 0.0 到 1.0。使用默认值 -1 时,Hugo 将省略站点地图中的此字段。参见 详情 。

覆盖默认值

在 front matter 中覆盖给定页面的默认值。

news.md
     
---
sitemap:
  changefreq: weekly
  disable: true
  priority: 0.8
title: News
---
+++
title = 'News'
[sitemap]
  changefreq = 'weekly'
  disable = true
  priority = 0.8
+++
{
   "sitemap": {
      "changefreq": "weekly",
      "disable": true,
      "priority": 0.8
   },
   "title": "News"
}

覆盖内置模板

要覆盖内置的 sitemap.xml 模板,请在以下任一位置创建一个新文件:

  • layouts/sitemap.xml
  • layouts/_default/sitemap.xml

在遍历页面集合时,分别使用 .Sitemap.ChangeFreq 和 .Sitemap.Priority 访问 更改频率 和 优先级 。

要覆盖内置的 sitemapindex.xml 模板,请在以下任一位置创建一个新文件:

  • layouts/sitemapindex.xml
  • layouts/_default/sitemapindex.xml

禁用站点地图生成

您可以在站点配置中禁用站点地图生成:

hugo.
     
disableKinds:
- sitemap
disableKinds = ['sitemap']
{
   "disableKinds": [
      "sitemap"
   ]
}

See also

  • Front matter (前置 matter)
  • 数学公式
  • Markdown 属性
  • Passthrough
  • RSS 模板

On this page

  • 概述
  • 配置
  • 覆盖默认值
  • 覆盖内置模板
  • 禁用站点地图生成
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护