spawnia/md-to-pdf

md-to-pdf

镜像概述和主要用途

md-to-pdf是一个将Markdown文档转换为PDF格式的Web服务。它提供直观的Web界面和灵活的API接口，支持多种PDF转换引擎，适用于快速转换需求或集成到其他应用中。用户可直接使用托管版本进行实验，也可通过Docker自行部署以确保服务可用性。

核心功能和特性

• Web界面：提供在线转换功能，支持粘贴Markdown内容并下载PDF
• API接口：通过POST请求实现程序化转换，支持自定义样式和转换引擎
• 多引擎支持：可选weasyprint、wkhtmltopdf或pdflatex转换引擎（默认weasyprint）
• 样式定制：允许通过CSS参数自定义PDF样式
• 文件输入支持：可直接从文件读取Markdown内容进行转换
• 可部署性：提供Docker镜像，支持本地或服务器部署

使用场景和适用范围

• 快速转换少量Markdown文档为PDF（使用托管Web版本）
• 需要稳定服务时自行部署（如企业内部使用）
• 集成到自动化工作流或应用程序中（通过API调用）
• 需要自定义PDF样式的场景（通过CSS参数）

使用方法和配置说明

Web UI使用

访问托管Web版本：[***]

1. 在文本框中粘贴Markdown内容
2. 点击转换按钮
3. 下载生成的PDF文件

注意：托管服务可用性不保证，服务中断时可查看Fly.io状态页。如需稳定服务，建议自行部署。

API调用

通过发送POST请求到服务端点进行转换。

请求示例

shell
curl --data-urlencode 'markdown=# 标题1' --output md-to-pdf.pdf https://md-to-pdf.fly.dev

参数说明

从文件读取内容

shell
curl --data-urlencode "markdown=$(cat example.md)" --output example.pdf https://md-to-pdf.fly.dev

Docker部署

基本部署

预构建镜像可从Docker Hub获取：https://hub.docker.com/r/spawnia/md-to-pdf

运行命令：

shell
docker run --publish=8000:8000 spawnia/md-to-pdf

服务将在本地8000端口启动，可通过http://localhost:8000访问Web界面。

高级配置

可通过Rocket环境变量配置Web服务器。例如，增加表单数据大小限制：

创建.env文件：

dotenv
ROCKET_LIMITS={form="1MiB"}

使用环境变量运行：

shell
docker run --publish=8000:8000 --env-file .env spawnia/md-to-pdf

技术栈

• Rocket - Rust Web框架
• Pandoc - 通用文档转换器
• Codemirror - 浏览器文本编辑器