参考手册

July 26, 2026 · View on GitHub

参考手册用于定点查阅,不提供线性教程。先确定要查询的是运行配置还是 Python调用面,再进入对应分支;具体任务步骤见指南

定位入口

需要查阅入口
对象、流程和后端术语术语表
完整配置树和部署字段配置总览
公共函数、request、结果与错误渲染 API
系统分层和依赖方向分层架构

配置参考

入口内容
配置总览完整 render 配置树和各专题入口
.env 配置dotenv 映射、加载优先级与常见后端示例
核心配置启动与生命周期 · 资源与访问策略 · 可选依赖与可观测性
HTML 后端Playwright · HTMLKit · Takumi
Graphics 后端Pillow · Skia

API 参考

入口内容
渲染 API通用函数、request、Renderer、类型化产物与执行错误
Preparation 与资源 APIprepare_*PreparedHtml、资源辅助函数
Application API默认对象图、startup、probe、close 与 admission
Capability 参考RasterScene、Playwright、Takumi 与 typed extension 属性