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

内容格式

使用 Markdown、HTML、Emacs Org 模式、AsciiDoc、Pandoc 或 reStructuredText 创建您的内容。

简介

您可以在整个站点中混合使用各种内容格式。例如:

content/
└── posts/
    ├── post-1.md
    ├── post-2.adoc
    ├── post-3.org
    ├── post-4.pandoc
    ├── post-5.rst
    └── post-6.html

无论内容格式如何,所有内容都必须包含 前置 matter ,最好同时包含 title 和 date 。

Hugo 根据前置 matter 中的 markup 标识符选择内容渲染器,如果找不到则回退到文件扩展名。请参见下面的 分类 表,了解标记标识符和识别文件扩展名的列表。

格式

Markdown

使用 Markdown 创建您的内容,前面加上前置 matter。

Markdown 是 Hugo 的默认内容格式。Hugo 使用 Goldmark 将 Markdown 本地渲染为 HTML。Goldmark 速度很快,并符合 CommonMark 和 GitHub Flavored Markdown 规范。您可以在站点配置中 配置 Goldmark 。

Hugo 提供自定义 Markdown 功能,包括:

属性
将 class 和 id 等 HTML 属性应用于 Markdown 图片和块元素,包括块引用、围栏代码块、标题、水平线、列表、段落和表格。
扩展
利用嵌入式 Markdown 扩展创建表格、定义列表、脚注、任务列表、插入文本、标记文本、下标、上标等等。
数学公式
使用 LaTeX 或 TeX 排版语法在 Markdown 中包含数学方程式和表达式。
渲染钩子
在渲染围栏代码块、标题、图像和链接时覆盖 Markdown 到 HTML 的转换。例如,将每个独立图像渲染为 HTML figure 元素。

HTML

使用 HTML 创建您的内容,前面加上前置 matter。内容通常是您放在 HTML 文档的 body 或 main 元素中的内容。

Emacs Org 模式

使用 Emacs Org 模式 格式创建您的内容,前面加上前置 matter。您可以使用 Org 模式关键字作为前置 matter。参见 详情 。

AsciiDoc

使用 AsciiDoc 格式创建您的内容,前面加上前置 matter。Hugo 使用 Asciidoctor 可执行文件将 AsciiDoc 内容渲染为 HTML。您必须安装 Asciidoctor 及其依赖项 (Ruby) 才能使用 AsciiDoc 内容格式。

您可以在站点配置中 配置 AsciiDoc 渲染器 。

在其默认配置中,Hugo 在调用 Asciidoctor 可执行文件时传递以下 CLI 标志:

--no-header-footer

传递给 Asciidoctor 可执行文件的 CLI 标志取决于配置。您可以在构建站点时检查这些标志:

hugo --logLevel info

Pandoc

使用 Pandoc 格式创建您的内容,前面加上前置 matter。Hugo 使用 Pandoc 可执行文件将 Pandoc 内容渲染为 HTML。您必须安装 Pandoc 才能使用 Pandoc 内容格式。

Hugo 在调用 Pandoc 可执行文件时传递以下 CLI 标志:

--mathjax

reStructuredText

使用 reStructuredText 格式创建您的内容,前面加上前置 matter。Hugo 使用 Docutils (特别是 rst2html)将 reStructuredText 内容渲染为 HTML。您必须安装 Docutils 及其依赖项 (Python) 才能使用 reStructuredText 内容格式。

Hugo 在调用 rst2html 可执行文件时传递以下 CLI 标志:

--leave-comments --initial-header-level=2

分类

内容格式 媒体类型 标识符 文件扩展名
Markdown text/markdown markdown markdown , md , mdown
HTML text/html html htm , html
Emacs Org 模式 text/org org org
AsciiDoc text/asciidoc asciidoc ad , adoc , asciidoc
Pandoc text/pandoc pandoc pandoc , pdc
reStructuredText text/rst rst rst

在将内容转换为 HTML 时,Hugo 使用:

  • Markdown、HTML 和 Emacs Org 模式的原生渲染器
  • AsciiDoc、Pandoc 和 reStructuredText 的外部渲染器

原生渲染器比外部渲染器速度更快。

See also

  • 配置标记
  • 文档
  • Front matter (前置 matter)
  • Markdown 属性
  • safe.CSS

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