Skip to content

2bitbit/mailify-md

Repository files navigation

mailify-md

简介

轻松将md文件转化为邮箱环境渲染后的html文件

light_demo

dark_demo

安装

# 安装包
pip install mailify-md
# 安装浏览器依赖
playwright install --with-deps

快速开始

# 用法一: 在原目录下生成同名 .html 文件
mailify-md test.md

# 用法二: 在指定输出目录下生成同名 .html 文件
mailify-md test.md ./output/

# 用法三: 指定输出文件名字和路径
mailify-md test.md ./output/email.html

之后复制 html 文件内容, 粘贴为邮件的 HTML 源码即可

功能特色

  • 结果美观:
    • 支持自定义 css 美化
    • 支持latex
    • 支持代码块(支持代码高亮)
    • 针对电脑和手机显示做了优化
  • 简单易用:
    • 一行命令得到可直接在email使用的html文件
    • 内置一些精美样式
  • 支持全面:
    • 自动处理远程和本地图片
    • 支持svg, gif, png等各种图片格式自动内嵌(无需修改你的md文件中的路径)

命令行用法

mailify-md INPUT_PATH [OUTPUT_PATH] [OPTIONS]

参数:

  • INPUT_PATH: 必须项,你的 Markdown 文件路径。
  • OUTPUT_PATH: 可选项,可以是:
    • 省略: 在输入文件目录下输出html文件。
    • 目录: 在指定目录下输出同名html文件。
    • 完整文件路径。

可选项:

  • -t, --theme TEXT: 设置主题。可以是 light, dark, 或一个自定义 CSS 文件的路径。
    • 示例: mailify-md test.md -t dark
    • 示例: mailify-md test.md -t ./my-style.css
    • (tip:可参考内置主题css设置)

作为库使用

你也可以在 Python 代码中直接调用 mailify_md: from mailify_md import mailify_md

附赠--炫酷html标签模板

<p align="center" style="font-size: 1em; font-style: italic; background: linear-gradient(270deg, #ff8a00, #e52e71, #4a90e2, #43e97b); color: transparent; background-clip: text; font-weight: bold; margin: 4em 0;">

对装逼邮件<br>
食髓知味的渴望<br>
根植于<span style="text-shadow: 0 0 10px rgb(250, 171, 0), 0 0 3px rgb(54, 51, 0);"> mailify-md </span>的用后成瘾

</p>

demo

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages