Project Icon

md2pdf

轻松将Markdown转换为样式化PDF文档

md2pdf是一个开源工具,用于将Markdown文件转换为样式化的PDF文档。它提供命令行界面和Python库接口,支持自定义CSS样式和Markdown扩展。用户可通过pip安装或使用Docker容器。基于Weasyprint构建,md2pdf适合开发者和写作者将Markdown转换为高质量PDF。支持外部CSS样式表,便于生成格式化的PDF文档,适用于报告、技术文档或电子书制作。

md2pdf标志

将Markdown文件转换为带样式的PDF。

GitHub Actions工作流状态 GitHub Actions工作流状态

安装

最简单的方法是使用pip:

$ pip install md2pdf

注意:在使用md2pdf之前,请确保Weasyprint功能完全正常。您可以在项目文档中找到安装说明:https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation

使用方法

作为命令行工具

用法: md2pdf [选项] MD PDF

  md2pdf命令行工具。

选项:
  --css PATH
  -e, --extras TEXT
  --version          显示版本并退出。
  --help             显示此消息并退出。

例如,尝试生成项目文档:

$ md2pdf README.md README.pdf

您也可以选择加载外部样式:

$ md2pdf --css tests/assets/input.css README.md README.pdf

和/或激活markdown扩展

$ md2pdf --css pygments.css -e fenced-code-blocks README.md README.pdf

作为库使用

您可以在Python代码中使用md2pdf,如下所示:

from md2pdf.core import md2pdf

md2pdf(pdf,
       md=None,
       raw=None,
       css=None,
       base_url=None,
       extras=[],
)

函数参数:

  • pdf:输出PDF文件路径
  • raw:输入markdown原始字符串内容
  • md:输入markdown文件路径
  • css:输入样式路径(CSS)
  • base_url:markdown链接内容(如图片)的绝对基本路径
  • extras:应该激活的markdown扩展

使用Docker

安装Docker

拉取镜像:

$ docker pull jmaupetit/md2pdf

现在运行您的镜像:

$ docker run --rm \
    -v $PWD:/app \
    -u "$(id -u):$(id -g)" \
    jmaupetit/md2pdf --css styles.css INPUT.MD OUTPUT.PDF

贡献

开发

首先克隆此项目:

$ git clone git@github.com:jmaupetit/md2pdf.git

安装md2pdf及其依赖项(使用Poetry):

$ cd md2pdf
$ poetry install

运行测试套件

要使用您的活动Python版本(虚拟环境)运行测试套件:

$ poetry run pytest

通过以下方式检查代码:

$ poetry run ruff md2pdf

发布新版本

将新版本上传到PyPI:

$ poetry build
$ poetry publish

简化您的工作

如果您熟悉GNU Make,我们还使用这个可爱的工具自动化日常任务:

$ make help

许可证

md2pdf根据MIT许可证发布。有关详细信息,请参阅随附的LICENSE文件。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号