nanozoo/md2pdf

md2pdf转换器镜像文档

镜像概述

本镜像为基于pandoc（https://pandoc.org/index.html%EF%BC%89%E7%9A%84Markdown%E8%BD%ACPDF%E8%BD%AC%E6%8D%A2%E5%99%A8%EF%BC%8C%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84%E6%96%87%E6%A1%A3%E6%A0%BC%E5%BC%8F%E8%BD%AC%E6%8D%A2%E5%8A%9F%E8%83%BD%E3%80%82%E7%BB%B4%E6%8A%A4%E8%80%85%E4%B8%BAChristian%EF%BC%8C%E9%87%87%E7%94%A8GNU General Public License 3许可证。

核心功能与特性

• 格式转换：通过pandoc实现Markdown（.md）文档到PDF格式的转换
• 兼容性：支持标准Markdown语法及pandoc支持的扩展语法
• 轻量便捷：无需本地安装pandoc及相关依赖，通过Docker容器即可快速使用

使用场景

• 文档作者需要将Markdown格式的文稿转换为PDF格式用于分享或打印
• 开发者需要将项目文档（如README.md）转换为PDF格式存档
• 教育工作者将Markdown课件转换为PDF格式分发给学生

使用方法

基本使用

通过docker run命令运行容器，挂载本地目录以实现文件输入输出：

bash
docker run -v /本地文档目录:/workspace docker.xuanyuan.run/md2pdf-converter pandoc /workspace/输入文件.md -o /workspace/输出文件.pdf

参数说明：

• -v /本地文档目录:/workspace：将本地存放Markdown文件的目录挂载到容器内的/workspace目录
• pandoc：调用pandoc转换工具
• /workspace/输入文件.md：容器内的Markdown源文件路径（对应本地挂载目录中的文件）
• -o /workspace/输出文件.pdf：指定转换后的PDF输出路径

高级配置

可直接使用pandoc的原生参数进行高级配置，例如指定PDF样式、添加元数据等：

bash
# 添加标题和作者信息
docker run -v /本地文档目录:/workspace docker.xuanyuan.run/md2pdf-converter pandoc /workspace/input.md -o /workspace/output.pdf --metadata title="文档标题" --metadata author="作者名称"

# 使用自定义CSS样式
docker run -v /本地文档目录:/workspace docker.xuanyuan.run/md2pdf-converter pandoc /workspace/input.md -o /workspace/output.pdf -c /workspace/style.css

注意事项

• 确保本地文档目录有读写权限，以便容器能够读取源文件和写入转换后的PDF文件
• 更多pandoc参数可参考官方文档：https://pandoc.org/MANUAL.html