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 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
CONTENT MANAGEMENT

原型

原型是新内容的模板。

概述

内容文件由 前置 matter 和标记语言组成。标记语言通常是 Markdown,但 Hugo 也支持其他 内容格式 。前置 matter 可以是 TOML、YAML 或 JSON。

hugo new content 命令使用原型作为模板,在 content 目录中创建一个新文件。这是默认原型:

archetypes/default.md
     
---
date: '{{ .Date }}'
draft: true
title: '{{ replace .File.ContentBaseName `-` ` ` | title }}'
---
+++
date = '{{ .Date }}'
draft = true
title = '{{ replace .File.ContentBaseName `-` ` ` | title }}'
+++
{
   "date": "{{ .Date }}",
   "draft": true,
   "title": "{{ replace .File.ContentBaseName `-` ` ` | title }}"
}

创建新内容时,Hugo 会评估原型中的 模板操作 。例如:

hugo new content posts/my-first-post.md

使用上面显示的默认原型,Hugo 创建此内容文件:

content/posts/my-first-post.md
     
---
date: "2023-08-24T11:49:46-07:00"
draft: true
title: My First Post
---
+++
date = '2023-08-24T11:49:46-07:00'
draft = true
title = 'My First Post'
+++
{
   "date": "2023-08-24T11:49:46-07:00",
   "draft": true,
   "title": "My First Post"
}

您可以为一个或多个 内容类型 创建原型。例如,为帖子使用一个原型,为其他所有内容使用默认原型:

archetypes/
├── default.md
└── posts.md

查找顺序

Hugo 在项目根目录的 archetypes 目录中查找原型,然后回退到主题或已安装模块中的 archetypes 目录。特定内容类型的原型优先于默认原型。

例如,使用此命令:

hugo new content posts/my-first-post.md

原型查找顺序为:

  1. archetypes/posts.md
  2. archetypes/default.md
  3. themes/my-theme/archetypes/posts.md
  4. themes/my-theme/archetypes/default.md

如果这些文件都不存在,Hugo 将使用内置的默认原型。

函数和上下文

您可以在原型中使用任何 模板函数 。如上所示,默认原型使用 replace 函数在填充前置 matter 中的标题时将连字符替换为空格。

原型接收以下上下文:

日期
(string) 当前日期和时间,格式符合 RFC3339。
文件
(hugolib.fileInfo) 返回当前页面的文件信息。参见 详细信息 。
类型
(string) 从顶级目录名称推断的 内容类型 ,或由传递给 hugo new content 命令的 --kind 标志指定。
站点
(page.Site) 当前站点对象。参见 详细信息 。

日期格式

要以不同的格式插入日期和时间,请使用 time.Now 函数:

archetypes/default.md
     
---
date: '{{ time.Now.Format "2006-01-02" }}'
draft: true
title: '{{ replace .File.ContentBaseName `-` ` ` | title }}'
---
+++
date = '{{ time.Now.Format "2006-01-02" }}'
draft = true
title = '{{ replace .File.ContentBaseName `-` ` ` | title }}'
+++
{
   "date": "{{ time.Now.Format \"2006-01-02\" }}",
   "draft": true,
   "title": "{{ replace .File.ContentBaseName `-` ` ` | title }}"
}

包含内容

尽管通常用作前置 matter 模板,但您也可以使用原型来填充内容。

例如,在文档站点中,您可能有一个用于函数的部分(内容类型)。此部分中的每个页面都应遵循相同的格式:简短描述、函数签名、示例和注释。我们可以预先填充页面以提醒内容作者标准格式。

archetypes/functions.md
---
date: '{{ .Date }}'
draft: true
title: '{{ replace .File.ContentBaseName `-` ` ` | title }}'
---

简要描述函数的功能,使用第三人称单数形式的简单现在时。例如:

`someFunction` 返回重复 `n` 次的字符串 `s` 。

## 签名 {#signature}

```text
func someFunction(s string, n int) string
```

## 示例 {#examples}

一个或多个实际示例,每个示例都在一个围栏代码块内。

## 注释 {#notes}

根据需要澄清的其他信息。

尽管您可以在内容主体中包含 模板操作 ,但请记住,Hugo 只会在内容创建时评估这些操作一次。在大多数情况下,请将模板操作放在 模板 中,Hugo 在每次 构建 站点时都会评估这些操作。

叶子捆绑包

您还可以为 叶子捆绑包 创建原型。

例如,在摄影网站中,您可能有一个用于图库的部分(内容类型)。每个图库都是包含内容和图像的叶子捆绑包。

为图库创建一个原型:

archetypes/
├── galleries/
│   ├── images/
│   │   └── .gitkeep
│   └── index.md      <-- 与 default.md 格式相同
└── default.md

原型中的子目录必须至少包含一个文件。如果没有文件,当您创建新内容时,Hugo 将不会创建子目录。文件的名稱和大小无关紧要。上面的示例包含一个 .gitkeep 文件,这是一个通常用于在 Git 存储库中保留其他空目录的空文件。

要创建一个新的图库:

hugo new galleries/bryce-canyon

这将生成:

content/
├── galleries/
│   └── bryce-canyon/
│       ├── images/
│       │   └── .gitkeep
│       └── index.md
└── _index.md

指定原型

创建内容时,使用 --kind 命令行标志指定原型。

例如,假设您的站点有两个部分:文章和教程。为每个内容类型创建一个原型:

archetypes/
├── articles.md
├── default.md
└── tutorials.md

要使用 articles 原型创建文章:

hugo new content articles/something.md

要使用 tutorials 原型创建文章:

hugo new content --kind tutorials articles/something.md

See also

  • Front matter (前置 matter)
  • 分类法
  • 数学公式
  • Markdown 属性
  • Passthrough

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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护