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 静态 Web 应用上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
内容管理

内容格式

使用 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

无论内容格式如何,所有内容都必须有前言,最好包括 title 和 date。

Hugo 根据前言中的 markup 标识符选择内容渲染器,并回退到文件扩展名。请参阅下面的分类表,了解标记标识符和可识别文件扩展名的列表。

格式

Markdown

使用Markdown创建内容,并在其前面添加前言。

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

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

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

HTML

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

Emacs Org 模式

使用Emacs Org 模式格式创建内容,并在其前面添加前言。您可以使用 Org 模式关键字作为前言。请参阅详细信息。

AsciiDoc

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

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

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

--no-header-footer

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

hugo --logLevel info

Pandoc

使用Pandoc 格式创建内容,并在其前面添加前言。Hugo 使用 Pandoc 可执行文件将 Pandoc 内容渲染为 HTML。您必须安装 Pandoc 才能使用 Pandoc 内容格式。

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

--mathjax

reStructuredText

使用 reStructuredText 格式创建内容,并在其前面添加前言。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 的外部渲染器

本地渲染器比外部渲染器快。

另请参阅

  • 配置标记
  • 文档
  • 代码块
  • 开发
  • 前言

本页内容

  • 简介
  • 格式
  • 分类
最后更新:2024 年 11 月 3 日: 删除多余的右括号 (c673880b6)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

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

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

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