Skip to main content

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

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-markdown2img

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

license pypi python

📖 介绍

可作为函数调用的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

🎉 使用

指令表

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

效果图

test_markdown_output

🙏 特别感谢

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_markdown2img-0.0.2.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_markdown2img-0.0.2-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_markdown2img-0.0.2.tar.gz.

File metadata

File hashes

Hashes for nonebot_plugin_markdown2img-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d0727eb95964023153ffb40f247394bcb560a79f2753f06c8fb0334b969536f6
MD5 33cc4c443007f33624539e45b8b34cc8
BLAKE2b-256 c5ab62747034356ee60bd2859f2a7cdb6f82269ff3419bde4ca34c9441fd0e1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for nonebot_plugin_markdown2img-0.0.2.tar.gz:

Publisher: release.yml on ANGJustinl/nonebot_plugin_markdown2img

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nonebot_plugin_markdown2img-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_markdown2img-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 793aec56692c525355708eff9ced5640cb7a6ea0e46c6c285c20c80fbdb4fe40
MD5 286911965048a79afc9c425fa9027111
BLAKE2b-256 96abc49d72c79445234d46befc3f1e3e53989ad81f5d121e2ed34ef07b79392d

See more details on using hashes here.

Provenance

The following attestation bundles were made for nonebot_plugin_markdown2img-0.0.2-py3-none-any.whl:

Publisher: release.yml on ANGJustinl/nonebot_plugin_markdown2img

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page