koishi-plugin-markdown-to-image-service

🎐 简介

koishi-plugin-markdown-to-image-service 是一款基于 Koishi 的插件，旨在提供将 Markdown 文本转换为图片的服务。

该插件支持完整的 Markdown 格式，包括 LaTeX 公式、Mermaid 流程图、代码高亮等功能。转换后的图片可用于分享和展示 Markdown 内容。

🎉 安装

您可通过 Koishi 插件市场搜索并安装该插件。

🌈 使用

当您在 Markdown 中引用本地图片时，务必使用相对路径。相对路径的根目录位于：./data/notebook。

例如，在 notebook 文件夹内有名为 0.png 的图片，那么您需要使用以下方式在 Markdown 中引用该图片：

![图片介绍](0.png)

🌼 指令

• markdownToImage [markdownText]：将 Markdown 文本转换为图片。

☕ 服务

• ctx.markdownToImage.convertToImage(markdownText: string): Promise<Buffer>

🌰 示例

// index.ts
import {Context, h} from 'koishi'
import {} from 'koishi-plugin-markdown-to-image-service'

export const inject = {
  required: ['markdownToImage'],
}

export async function apply(ctx: Context) {
  ctx.command('test', '测试')
    .action(async ({session}) => {
      const imageBuffer = await ctx.markdownToImage.convertToImage('# Hello')
      return h.image(imageBuffer, 'image/png') // 'image/png' | 'image/jpeg'
    });

}

🍧 致谢

• Koishi - 提供机器人框架支持
• crossnote - 提供 Markdown 渲染引擎支持

🐱 QQ 群

• 956758505

✨ License

MIT License © 2024

希望您喜欢这款插件！ 💫

如有任何问题或建议，欢迎联系我哈~ 🎈