HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio 加星
  • 关于
    • 本节内容
    • 简介
    • 功能特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前置元数据
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go 模板
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • 菜单项
    • Page
    • Pager
    • Pages
    • Resource
    • 短代码
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图像
    • 链接
    • 直接传递
    • 表格
  • 短代码
    • 本节内容
    • 评论
    • 详情
    • 图
    • Gist
    • 高亮
    • Instagram
    • Param
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 本节内容
    • 简介
    • 将 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 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
函数 图像函数

images.QR

使用指定的选项将给定的文本编码为 QR 码,并返回图像资源。

语法

images.QR TEXT OPTIONS

返回

images.ImageResource
v0.141.0 新增

images.QR 函数使用指定的选项将给定的文本编码为 QR 码,并返回图像资源。生成的图像大小取决于三个因素

  • 数据长度:较长的文本需要更大的图像以容纳增加的信息密度。
  • 纠错级别:较高的纠错级别增强了 QR 码的抗损坏能力,但这通常会导致图像尺寸略微增大以保持可读性。
  • 每个模块的像素数:分配给每个单独模块(QR 码的最小单元)的图像像素数直接影响整体图像大小。每个模块的像素计数越高,生成的图像越大,分辨率越高。

虽然默认选项值对于大多数应用来说足够了,但您应该在屏幕上和打印中测试渲染的 QR 码。

选项

level
(string)编码文本时使用的纠错级别,可以是 low、medium、quartile 或 high 之一。默认值为 medium。
纠错级别 冗余
低 20%
中 38%
四分位 55%
高 65%
scale
(int)每个 QR 码模块的图像像素数。必须大于或等于 2。默认值为 4。
targetDir
(string)在 publishDir 中的子目录,Hugo 会将生成的图像放置在该目录中。使用 Unix 风格的斜杠 (/) 分隔路径段。如果为空或未提供,则图像将直接放置在 publishDir 根目录中。如果子目录不存在,Hugo 会自动创建必要的子目录。

示例

要使用 level 和 scale 的默认值创建 QR 码

{{ $text := "https://gohugo.com.cn" }}
{{ with images.QR $text }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

根据需要指定 level、scale 和 targetDir 以实现所需的结果

{{ $text := "https://gohugo.com.cn" }}
{{ $opts := dict 
  "level" "high" 
  "scale" 3
  "targetDir" "codes"
}}
{{ with images.QR $text $opts }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

缩放

当您减小 QR 码的大小时,设备可以可靠扫描它的最大距离也会减小。

在上面的示例中,我们将 scale 设置为 2,从而生成一个每个模块由 2x2 像素组成的 QR 码。虽然这可能足以在屏幕上显示,但在以 600 dpi 打印时可能会出现问题。

\[ \frac{2\:px}{module} \times \frac{1\:inch}{600\:px} \times \frac{25.4\:mm}{1\:inch} = \frac{0.085\:mm}{module} \]

此模块大小是通常建议的最小尺寸 0.170 毫米的一半。
如果 QR 码将被打印,请使用默认的 scale 值,即每个模块 4 个像素。

避免使用 Hugo 的图像处理方法来调整 QR 码的大小。当 QR 码模块占用小数个像素时,调整大小可能会因抗锯齿而导致模糊。

始终在屏幕上和打印中测试渲染的 QR 码。

短代码

调用 qr 短代码将 QR 码插入到您的内容中。

使用自闭合语法将文本作为参数传递

{{< qr text="https://gohugo.com.cn" />}}

或在打开和关闭标签之间插入文本

{{< qr >}}
https://gohugo.com.cn
{{< /qr >}}

qr 短代码接受多个参数,包括 level 和 scale。有关详细信息,请参阅相关文档。

本页内容

  • 选项
  • 示例
  • 缩放
  • 短代码

本节内容

  • images.AutoOrient
  • images.Brightness
  • images.ColorBalance
  • images.Colorize
  • images.Config
  • images.Contrast
  • images.Dither
  • images.Filter
  • images.Gamma
  • images.GaussianBlur
  • images.Grayscale
  • images.Hue
  • images.Invert
  • images.Mask
  • images.Opacity
  • images.Overlay
  • images.Padding
  • images.Pixelate
  • images.Process
  • images.QR
  • images.Saturation
  • images.Sepia
  • images.Sigmoid
  • images.Text
  • images.UnsharpMask
上次更新时间:2025 年 1 月 16 日: 将嵌入式短代码文档提升到其自己的部分 (a346ca1fd)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

贵公司?
 

Hugo 标志的版权归 © Steve Francia 2013–2025 所有。

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

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