HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 介绍
    • 特性
    • 隐私
    • 安全
    • 许可
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 介绍
    • 模板类型
    • 查找顺序
    • 基础模板
    • 首页模板
    • 单页模板
    • 节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pager
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 本节内容
    • 介绍
    • 块引用
    • 代码块
    • 标题
    • 图像
    • 链接
    • 直通
    • 表格
  • 短代码
    • 本节内容
    • 评论
    • 详情
    • 图
    • Gist
    • 高亮
    • Instagram
    • 参数
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 介绍
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后处理
    • JavaScript 构建
    • 资产压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串生成资源
    • 从模板生成资源
  • CLI
  • 故障排除
    • 本节内容
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题解答
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
内容管理

原型

原型是新内容的模板。

概述

内容文件由前言和标记组成。标记通常是 Markdown,但 Hugo 也支持其他内容格式。前言可以是 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 函数在填充前言中的标题时将连字符替换为空格。

原型接收以下上下文

Date
(string)当前日期和时间,格式符合 RFC3339。
File
(hugolib.fileInfo)返回当前页面的文件信息。请参阅详细信息。
Type
(string)从顶层目录名称推断出的内容类型,或由传递给 hugo new content 命令的 --kind 标志指定。
Site
(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 }}"
}

包含内容

虽然通常用作前言模板,但您也可以使用原型来填充内容。

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

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

A brief description of what the function does, using simple present tense in the third person singular form. For example:

`someFunction` returns the string `s` repeated `n` times.

## Signature

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

## Examples

One or more practical examples, each within a fenced code block.

## Notes

Additional information to clarify as needed.

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

叶子包

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

例如,在摄影站点中,您可能有一个用于画廊的节(内容类型)。每个画廊都是带有内容和图像的叶子包。

为画廊创建原型

archetypes/
├── galleries/
│   ├── images/
│   │   └── .gitkeep
│   └── index.md      <-- same format as 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

要使用文章原型创建文章

hugo new content articles/something.md

要使用教程原型创建文章

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

另请参阅

  • 前言
  • 分类法
  • 构建选项
  • 内容适配器
  • Markdown 属性

本页内容

  • 概述
  • 查找顺序
  • 函数和上下文
  • 日期格式
  • 包含内容
  • 叶子包
  • 指定原型
上次更新时间:2025 年 1 月 16 日:将目录名称、文件名和文件路径格式化为代码 (8051ff818)
改进此页面
由 Hugo 作者 贡献
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 标志版权归 Steve Francia 2013-2025 所有。

Hugo 地鼠基于 Renée French 的原创作品。

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