satori

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Node.js >= 16（浏览器和 Web Workers 也可直接运行）
• 支持 JSX 的构建/运行环境（Satori 接受 JSX 语法）
• 至少一个字体文件，以 Buffer/ArrayBuffer 形式提供

安装与启动步骤

1. 1安装 satori

   README 示例中从 'satori' 包导入，因此在项目里安装同名 npm 包即可（README 未直接给出安装命令，此为按包名推断）。

   npm install satori

   复制

2. 2读取字体数据

   用 Node.js 的 fs 或 fetch 把字体读成 Buffer/ArrayBuffer，赋值给 fonts[].data，否则无法渲染文字。

3. 3编写渲染代码

   用 JSX 描述要渲染的元素，调用 satori 并传入宽高与字体配置，JSX 必须是纯的、无状态的元素。

   import satori from 'satori'
   
   const svg = await satori(
     <div style={{ color: 'black' }}>hello, world</div>,
     {
       width: 600,
       height: 400,
       fonts: [
         {
           name: 'Roboto',
           data: robotoArrayBuffer,
           weight: 400,
           style: 'normal',
         },
       ],
     },
   )

   复制

4. 4取出 SVG 结果

   satori 返回 SVG 字符串，形如 '<svg ...><path d="..." fill="black"></path></svg>'，可直接使用或落盘保存。

关键配置

如何确认成功

调用后返回的字符串以 '<svg' 开头并包含 '<path d="..." fill="black">' 等节点，即渲染成功。

常见问题

注意事项

• Satori 只接受纯的、无状态的 JSX 元素
• Node.js 版本需 >= 16
• 字体必须显式以 Buffer/ArrayBuffer 形式提供，README 未给出安装命令，安装步骤为按包名推断