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 属性

使用 Markdown 属性在将 Markdown 渲染为 HTML 时添加 HTML 属性。

概述

Hugo 支持在图像和块级元素(包括块引用、围栏代码块、标题、水平线、列表、段落和表格)上使用 Markdown 属性。

例如:

这是一个段落。
{class="foo bar" id="baz"}

使用 class 和 id ,您可以使用简写形式:

这是一个段落。
{.foo .bar #baz}

Hugo 将这两个示例都渲染为:

<p class="foo bar" id="baz">这是一个段落。</p>

块级元素

更新您的站点配置以启用块级元素的 Markdown 属性。

hugo.
     
markup:
  goldmark:
    parser:
      attribute:
        block: true
        title: true
[markup]
  [markup.goldmark]
    [markup.goldmark.parser]
      [markup.goldmark.parser.attribute]
        block = true
        title = true
{
   "markup": {
      "goldmark": {
         "parser": {
            "attribute": {
               "block": true,
               "title": true
            }
         }
      }
   }
}

独立图像

默认情况下,当 Goldmark Markdown 渲染器遇到独立的图像元素(同一行上没有其他元素或文本)时,它会根据 CommonMark 规范 将图像元素包装在段落元素中。

如果您要在图像元素下方放置属性列表,Hugo 会将属性应用于周围的段落,而不是图像本身。

要将属性应用于独立的图像元素,您必须禁用默认的包装行为:

hugo.
     
markup:
  goldmark:
    parser:
      wrapStandAloneImageWithinParagraph: false
[markup]
  [markup.goldmark]
    [markup.goldmark.parser]
      wrapStandAloneImageWithinParagraph = false
{
   "markup": {
      "goldmark": {
         "parser": {
            "wrapStandAloneImageWithinParagraph": false
         }
      }
   }
}

使用方法

您可以添加 全局 HTML 属性 ,或当前元素类型特有的 HTML 属性。与它的内容安全模型一致,Hugo 会移除 HTML 事件属性,例如 onclick 和 onmouseover 。

属性列表由一个或多个键值对组成,它们用空格或逗号分隔,并用大括号括起来。您必须用引号括起包含空格的字符串值。与 HTML 不同,布尔属性必须同时具有键和值。

例如:

> 这是一个块引用。
{class="foo bar" hidden=hidden}

Hugo 将其渲染为:

<blockquote class="foo bar" hidden="hidden">
  <p>这是一个块引用。</p>
</blockquote>

在大多数情况下,请将属性列表放在标记元素下方。对于标题和围栏代码块,请将属性列表放在右侧。

元素 属性列表位置
块引用 底部
围栏代码块 右侧
标题 右侧
水平线 底部
图像 底部
列表 底部
段落 底部
表格 底部

例如:

## Section 1 {class=foo} {#section-1-class-foo}

```bash {class=foo linenos=inline}
declare a=1
echo "${a}"
```

这是一个段落。
{class=foo}

如上所示,围栏代码块的属性列表不限于 HTML 属性。您还可以通过传递一个或多个 这些选项 来配置语法高亮显示。

See also

  • 配置标记
  • 从模板创建资源
  • Front matter (前置 matter)
  • 数学公式
  • 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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护