nonebot-plugin-markdown2img 0.0.3rc1

可作为函数调用的Markdown渲染图片插件

nonebot-plugin-markdown2img

✨ 可作为函数调用的Markdown渲染图片插件 ✨

📖 介绍

可作为函数调用的Markdown渲染图片插件

直接作为插件使用

安装并配置好插件后，无需额外导入函数，直接在群聊中发送指令即可使用。例如：

发送 md2img # 标题\n\n这是一段**粗体**文本。，即可收到渲染后的图片。

作为函数调用

你可以直接导入并使用渲染函数：

from nonebot_plugin_markdown2img.renderer import render_markdown_to_base64
# or
# from src.nonebot_plugin_markdown2img.renderer import render_markdown_to_base64

# 渲染Markdown文本为base64图片
markdown_text = "# 标题\n\n这是一段**粗体**文本。"
base64_image = render_markdown_to_base64(markdown_text)

💿 安装

若遇到缺少Markdown渲染图片失败，原因:Linkify enabled but not installed.. 请检查日志。报错, 请额外安装linkify-it-py!

使用 nb-cli 安装

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot_plugin_markdown2img

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install nonebot_plugin_markdown2img

pdm

pdm add nonebot_plugin_markdown2img

poetry

poetry add nonebot_plugin_markdown2img

conda

conda install nonebot_plugin_markdown2img

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

plugins = ["nonebot_plugin_markdown2img"]

⚙️ 配置

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项	必填	默认值	说明
font_path	否	无	字体文件路径
disable_gpu	否	True	是否禁用GPU
disable_linkify	否	True	是否禁用Linkify
browser	否	"chrome"	指定使用的浏览器类型, 可选值有 "chrome", "edge", "firefox" 等
browser_executable	否	None	指定浏览器可执行文件的路径(Windows比较常见的有 C:\Program Files (x86)\Microsoft\Edge\Application)

🎉 使用

指令表

指令	权限	需要@	范围	说明
md2img	群员	否	群聊	md2img + 想要生成图片的markdown文本

效果图

🙏 特别感谢

感谢 nonebot_plugin_easymarkdown 项目提供的灵感和参考。