将Markdown文件转换为带样式的PDF。
安装
最简单的方法是使用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文件。