markdown-to-image-service:提供完整 Markdown 格式支持的文本转图片服务

koishi-plugin-markdown-to-image-service

npm

:wind_chime: 简介

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

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

:tada: 安装

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

:rainbow: 使用

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

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

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

:blossom: 指令

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

:coffee: 服务

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

:chestnut: 示例

// index.ts
import { Context } from 'koishi'
import { } from 'koishi-plugin-markdown-to-image-service'
  
export const inject = ['markdownToImage']
  
export async function apply(ctx: Context) {
  const imageBuffer = await ctx.markdownToImage.convertToImage('# Hello')
  return h.image(imageBuffer, 'image/png') // 'image/png', 'image/jpeg'
}

:shaved_ice: 致谢

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

:sparkles: License

MIT © 2023

4 个赞

部分功能图片示例

点击展开




插件配置项示例(可选主题 20+)

点击展开

换主题请打开此选项


2 个赞

好耶!

2 个赞