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 提供了用于常见用例的内嵌模板。

Disqus

要覆盖 Hugo 内嵌的 Disqus 模板,请将 源代码 复制到 layouts/partials 目录下同名文件中,然后使用 partial 函数在你的模板中调用它:

{{ partial "disqus.html" . }}

Hugo 内嵌了一个用于 Disqus 的模板,Disqus 是一个流行的静态和动态网站评论系统。要有效使用 Disqus,请通过 注册 免费服务来获取 Disqus 的“短名称”。

要包含内嵌模板:

{{ template "_internal/disqus.html" . }}

配置 Disqus

要使用 Hugo 的 Disqus 模板,首先设置单个配置值:

hugo.
     
services:
  disqus:
    shortname: your-disqus-shortname
[services]
  [services.disqus]
    shortname = 'your-disqus-shortname'
{
   "services": {
      "disqus": {
         "shortname": "your-disqus-shortname"
      }
   }
}

Hugo 的 Disqus 模板使用以下方式访问此值:

{{ .Site.Config.Services.Disqus.Shortname }}

你也可以在给定内容的前置内容中设置以下内容:

  • disqus_identifier
  • disqus_title
  • disqus_url

Google Analytics

要覆盖 Hugo 内嵌的 Google Analytics 模板,请将源代码复制到 layouts/partials 目录下同名文件中,然后使用partial函数在你的模板中调用它:

{{ partial "google_analytics.html" . }}

Hugo 内嵌了一个支持Google Analytics 4的模板。

要包含内嵌模板:

{{ template "_internal/google_analytics.html" . }}

配置 Google Analytics

在你的配置文件中提供你的跟踪 ID:

hugo.
     
services:
  googleAnalytics:
    id: G-MEASUREMENT_ID
[services]
  [services.googleAnalytics]
    id = 'G-MEASUREMENT_ID'
{
   "services": {
      "googleAnalytics": {
         "id": "G-MEASUREMENT_ID"
      }
   }
}

要在你自己的模板中使用此值,请使用 {{ site.Config.Services.GoogleAnalytics.ID }} 访问已配置的 ID。

Open Graph

要覆盖 Hugo 内嵌的 Open Graph 模板,请将源代码复制到 layouts/partials 目录下同名文件中,然后使用partial函数在你的模板中调用它:

{{ partial "opengraph.html" . }}

Hugo 内嵌了一个用于 Open Graph 协议 的模板,此元数据使页面能够成为社交图谱中的丰富对象。 此格式用于 Facebook 和其他一些网站。

要包含内嵌模板:

{{ template "_internal/opengraph.html" . }}

配置 Open Graph

Hugo 的 Open Graph 模板是使用配置设置和各个页面的 前置内容 的混合来配置的。

hugo.
     
params:
  description: 关于我酷炫网站的文字
  images:
  - site-feature-image.jpg
  social:
    facebook_admin: jsmith
  title: 我的酷炫网站
taxonomies:
  series: series
[params]
  description = '关于我酷炫网站的文字'
  images = ['site-feature-image.jpg']
  title = '我的酷炫网站'
  [params.social]
    facebook_admin = 'jsmith'
[taxonomies]
  series = 'series'
{
   "params": {
      "description": "关于我酷炫网站的文字",
      "images": [
         "site-feature-image.jpg"
      ],
      "social": {
         "facebook_admin": "jsmith"
      },
      "title": "我的酷炫网站"
   },
   "taxonomies": {
      "series": "series"
   }
}
content/blog/my-post.md
     
---
audio: []
date: 2024-03-08T08:18:11-08:00
description: 关于这篇文章的文字
images:
- post-cover.png
series: []
tags: []
title: 文章标题
videos: []
---
+++
audio = []
date = 2024-03-08T08:18:11-08:00
description = '关于这篇文章的文字'
images = ['post-cover.png']
series = []
tags = []
title = '文章标题'
videos = []
+++
{
   "audio": [],
   "date": "2024-03-08T08:18:11-08:00",
   "description": "关于这篇文章的文字",
   "images": [
      "post-cover.png"
   ],
   "series": [],
   "tags": [],
   "title": "文章标题",
   "videos": []
}

Hugo 使用页面标题和描述作为标题和描述元数据。 images 数组中的前6个URL用于图像元数据。 如果使用 页面包 并且 images 数组为空或未定义,则使用文件名匹配 *feature* 、 *cover* 或 *thumbnail* 的图像作为图像元数据。

还可以设置各种可选元数据:

  • 如果指定了日期、发布日期和最后修改日期,则用于设置发布时间的元数据。
  • audio 和 videos 与 images 类似,都是用于音频和视频元数据标签的URL数组。
  • 页面的前6个 tags 用于tags元数据。
  • series 分类法用于通过将它们放在同一系列中来指定相关的“参见”页面。

如果使用 YouTube,这将生成一个类似于 <meta property="og:video" content="url"> 的og:video标签。对YouTube视频使用 https://youtu.be/<id> 格式(例如: https://youtu.be/qtIqKaDlqXo )。

Schema

要覆盖 Hugo 内嵌的 Schema 模板,请将源代码复制到 layouts/partials 目录下同名文件中,然后使用partial函数在你的模板中调用它:

{{ partial "schema.html" . }}

Hugo 内嵌了一个模板来渲染模板的 head 元素中的微数据meta 元素。

要包含内嵌模板:

{{ template "_internal/schema.html" . }}

X (Twitter) Cards

要覆盖 Hugo 内嵌的 Twitter Cards 模板,请将源代码复制到 layouts/partials 目录下同名文件中,然后使用partial函数在你的模板中调用它:

{{ partial "twitter_cards.html" . }}

Hugo 内嵌了一个用于 X (Twitter) Cards 的模板, 此元数据用于将富媒体附加到链接到你的网站的推文中。

要包含内嵌模板:

{{ template "_internal/twitter_cards.html" . }}

配置 X (Twitter) Cards

Hugo 的 X (Twitter) Card 模板是使用配置设置和各个页面上的 前置内容 值混合配置的。

hugo.
     
params:
  description: 关于我酷炫网站的文字
  images:
  - site-feature-image.jpg
[params]
  description = '关于我酷炫网站的文字'
  images = ['site-feature-image.jpg']
{
   "params": {
      "description": "关于我酷炫网站的文字",
      "images": [
         "site-feature-image.jpg"
      ]
   }
}
content/blog/my-post.md.
     
description: 关于这篇文章的文字
images:
- post-cover.png
title: 文章标题
description = '关于这篇文章的文字'
images = ['post-cover.png']
title = '文章标题'
{
   "description": "关于这篇文章的文字",
   "images": [
      "post-cover.png"
   ],
   "title": "文章标题"
}

如果使用 页面包 并且 images 数组为空或未定义,则使用文件名匹配 *feature* 、 *cover* 或 *thumbnail* 的图像作为图像元数据。 如果找不到具有这些名称的图像资源,则使用 站点配置 中定义的图像。 如果根本找不到任何图像,则使用无图像的 Twitter summary 卡片代替 summary_large_image 。

Hugo 使用页面标题和描述作为卡片的标题和描述字段。如果没有提供描述,则使用页面摘要。

在你的站点配置中设置 twitter:site 的值:

hugo.
     
params:
  social:
    twitter: GoHugoIO
[params]
  [params.social]
    twitter = 'GoHugoIO'
{
   "params": {
      "social": {
         "twitter": "GoHugoIO"
      }
   }
}

注意: @ 将由系统自动添加

<meta name="twitter:site" content="@GoHugoIO"/>

See also

  • 评论

On this page

  • Disqus
  • Google Analytics
  • Open Graph
  • Schema
  • X (Twitter) Cards
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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护