nonebot-plugin-htmlrender 文档¶
nonebot-plugin-htmlrender 是一个面向 NoneBot 生态的库型渲染插件。
它基于浏览器语义提供统一渲染能力,把文本、Markdown、HTML 和模板页面渲染为图片,适合消息卡片、海报、榜单、报告图和模板化内容生成等场景。
它的定位不是“开箱即用的业务插件”,而是“渲染能力库”:
- 不内置可直接触发的 matcher
- 由业务插件或应用代码负责接收事件或命令
- 由本插件负责生成图片或提供底层页面上下文
如果你只关心怎么接入,请走用户文档。
如果你要继续维护这个仓库、排查底层行为或参与重构,请走开发者文档。
你可以在这里找到什么¶
核心能力:
- 统一渲染 API:
render_text、render_markdown、render_html、render_template - 远程能力支持:远程 Playwright / 远程浏览器两种接入模式
- 资源解析链路:可选接入 filehost 解决远程浏览器读取本地资源问题
- 观测能力扩展:可选接入 sentry / prometheus 观察渲染链路指标与异常
- 兼容层过渡:保留旧接口用于迁移,但新项目推荐直接使用新 API
文档结构:
- 面向用户:接入、配置、调用、排障、迁移
- 面向开发者:架构、协作流程、测试矩阵、CI 与版本发布
阅读路径¶
用户文档¶
- 用户概览
- 快速开始
- API 与兼容层
- 配置总览
- 基础配置与加载
- Playwright 配置
- 依赖扩展与观测
- 示例项目
- 最佳实践
- 远程 Playwright 与 Filehost
- 故障排查
- 常见问题
- 安全须知
- 旧版本迁移指南