nonebot-plugin-htmlrender 0.6.7

通过浏览器渲染图片

nonebot-plugin-htmlrender

• 通过浏览器渲染图片
• 可通过查看example参考使用实例
• 如果有安装浏览器等问题，先查看文档最底下的常见问题再去看 issue 有没有已经存在的

✨ 功能

• 通过 html 和浏览器生成图片
• 支持纯文本 markdown 和 jinja2 模板输入
• 通过 CSS 来控制样式

使用

参考example/plugins/render/init.py

from nonebot import require

require("nonebot_plugin_htmlrender")
# 注意顺序，先require再 from ... import ...
# 注意顺序，先require再 from ... import ...
# 注意顺序，先require再 from ... import ...
from nonebot_plugin_htmlrender import (
    text_to_pic,
    md_to_pic,
    template_to_pic,
    get_new_page,
)
# 注意顺序，先require再 from ... import ...
# 注意顺序，先require再 from ... import ...
# 注意顺序，先require再 from ... import ...

配置

.env 配置项说明

# Playwright 浏览器引擎类型
# 可不填，默认为 "chromium"
htmlrender_browser = "chromium"

# Playwright 浏览器下载地址
# 可选，用于自定义浏览器下载源
htmlrender_download_host = ""

# Playwright 浏览器下载代理
# 可选，用于配置下载浏览器时的代理
htmlrender_download_proxy = ""

# Playwright 浏览器代理地址
# 可选，用于配置浏览器访问时的代理
# 示例: htmlrender_proxy_host = "http://127.0.0.1:7890"

# Playwright 浏览器代理绕过地址
# 可选，指定不使用代理的地址
htmlrender_proxy_host_bypass = ""

# Playwright 浏览器通道
# 可选，支持以下值:
# - Chrome: "chrome", "chrome-beta", "chrome-dev", "chrome-canary"
# - Edge: "msedge", "msedge-beta", "msedge-dev", "msedge-canary"
# 配置后可直接使用系统浏览器，无需下载 Chromium
htmlrender_browser_channel = ""

# Playwright 浏览器可执行文件路径
# 可选，用于指定浏览器程序位置
htmlrender_browser_executable_path = ""

# CDP 远程调试地址
# 可选，用于连接已运行的浏览器实例
# 使用时需要在启动浏览器时添加参数 --remote-debugging-port=端口号
htmlrender_connect_over_cdp = "http://127.0.0.1:9222"

# Playwright ws 连接地址
# 可选，用于连接 playwright 的 docker 容器
# https://playwright.dev/docs/docker
# 配套的 docker-compose.yaml 中，已经填好了
htmlrender_connect="ws://playwright:3000"

部署

（建议）使用 docker compose 进行部署

前提条件：你的项目使用 uv 管理 或 pyproject.toml 的 dependencies 中已经包含你的依赖

此方法会将 nonebot2 和 playwright 分开两个容器

1. 将 docker-compose.yaml & entrypoint.sh 复制到你自己的项目根目录下
2. 根据你的需要调整 docker-compose.yaml & entrypoint.sh
3. 拉取镜像 docker compose pull
4. 启动容器 docker compose up -d

• 查看日志 docker compose logs -f
• 停止/重启容器 docker compose

docker 单容器部署

前提条件：你的项目使用 uv 管理 或 pyproject.toml 的 dependencies 中已经包含你的依赖

此方法会将 nonebot2 和 playwright 运行在同一个容器中

而且你还有需要清楚你要干什么

1. 将 docker-compose.yaml & entrypoint.sh 复制到你自己的项目根目录下
2. 根据你的情况，调整指令

docker run -d \
--name nonebot2 \
-v $(pwd):/app \
-p 9012:9012 \
-e "PLAYWRIGHT_BROWSERS_PATH=/app/pw-browsers" \
ghcr.io/kexue-z/nonebot-plugin-htmlrender/nonebot2-playwrght-uv sh -c "./entrypoint.sh"

说明

markdown 转 图片

• 使用 GitHub-light 样式
• 支持绝大部分 md 语法
• 代码高亮
• latex 数学公式 （感谢@MeetWq）
  • 使用 $$...$$ 来输入独立公式
  • 使用 $...$ 来输入行内公式
• 图片需要使用外部连接并使用html格式 否则文末会超出截图范围
• 图片可使用 md 语法 路径可为 绝对路径(建议), 或 相对于template_path 的路径

模板 转 图片

• 使用 jinja2 模板引擎
• 页面参数可自定义

🌰 栗子

example.md

文本转图片（同时文本里面可以包括 html 图片）

markdown 转图片（同时文本里面可以包括 html 图片）

纯 html 转图片

jinja2 模板转图片

特别感谢

• MeetWq 提供数学公式支持代码和代码高亮

常见疑难杂症

playwright._impl._api_types.Error: 初次运行时报错

• 一般为缺少必要的运行环境，如中文字体等

Ubuntu 使用 apt

• 参考Dao-bot Dockerfile

apt update && apt install -y locales locales-all fonts-noto libnss3-dev libxss1 libasound2 libxrandr2 libatk1.0-0 libgtk-3-0 libgbm-dev libxshmfence1

• 然后设置 ENV local

LANG zh_CN.UTF-8
LANGUAGE zh_CN.UTF-8
LC_ALL zh_CN.UTF-8