跳到主要内容

配置

配置文件

html2png 支持 TOML 配置文件,用于设置默认值和简化工作流程。

生成配置文件

html2png init-config

这将在当前目录创建 .html2png.toml,包含默认值。

搜索顺序

配置文件按以下顺序搜索:

  1. .html2png.toml(当前目录)
  2. html2png.toml(当前目录)
  3. ~/.config/html2png/config.toml(用户配置)

配置优先级

CLI 参数 > 配置文件 > 默认值

配置文件结构

[browser]
# 浏览器引擎:"chromium"、"firefox" 或 "webkit"
engine = "chromium"
# 无头模式运行
headless = true
# 慢速操作,延迟 N 毫秒(用于调试)
slow_mo = 0

[render]
# 视口配置
[render.viewport]
width = 1080
height = 1440

# 设备像素比,用于高分辨率输出
device_scale_factor = 3.0

# 截取完整页面或仅视口
full_page = true

# 禁用动画以获得一致的截图
disable_animations = true

# 截图前等待特定的 CSS 选择器
# wait_for_selector = ".content-loaded"

# 页面加载策略:"commit"、"domcontentloaded"、"load" 或 "networkidle"
wait_strategy = "domcontentloaded"

# 导航超时时间(毫秒)
wait_for_timeout = 60000

# JPEG 图像质量(0-100)
quality = 80

# 输出格式:"png" 或 "jpeg"
output_format = "png"

# 批量操作的并行 worker 数量
parallel_workers = 1

选项参考

浏览器选项

选项类型默认值描述
enginestr"chromium"使用的浏览器引擎
headlessbooltrue无头模式运行浏览器
slow_moint0慢速操作,延迟 N 毫秒

渲染选项

选项类型默认值描述
viewport.widthint1080视口宽度(像素)
viewport.heightint1440视口高度(像素)
device_scale_factorfloat3.0设备像素比
full_pagebooltrue截取完整页面
disable_animationsbooltrue禁用动画
wait_for_selectorstr | nullnull等待的 CSS 选择器
wait_strategystr"domcontentloaded"页面加载策略
wait_for_timeoutint60000超时时间(毫秒)
qualityint | nullnullJPEG 质量(0-100)
zoomfloat1.0页面缩放级别

输出选项

选项类型默认值描述
output_formatstr"png"输出格式(png/jpeg)
parallel_workersint1批量处理的并行 worker 数

页面加载策略

策略描述
commit立即开始加载(最快,用于本地文件)
domcontentloaded等待 DOM 解析完成(默认,最可靠)
load等待所有资源加载(图片、样式表等)
networkidle等待 500ms 无网络请求(可能在慢页面超时)

示例

移动端预览配置

[render.viewport]
width = 375
height = 667

[render]
device_scale_factor = 2.0

高质量 JPEG 配置

[render]
quality = 95
device_scale_factor = 2.0

[browser]
engine = "chromium"

快速批量处理

[render]
wait_strategy = "commit"
disable_animations = true
full_page = false

parallel_workers = 4