ghpdf 

3周前发布 14 00

ghpdf 是一个无需配置、无需 LaTeX、无需模板的命令行工具,只需一行命令,即可将 .md 文件转为视觉一致的 PDF。

所在地:
中国
收录时间:
2025-12-27

写文档用 Markdown,但需要交付 PDF

你希望 PDF 的排版、代码高亮、表格样式和 GitHub 上看到的一模一样

ghpdf 是一个无需配置、无需 LaTeX、无需模板的命令行工具,只需一行命令,即可将 .md 文件转为视觉一致的 PDF

ghpdf 

为什么选择 ghpdf?

特性说明
✅ GitHub 原生样式代码块、表格、任务列表、脚注等渲染效果与 GitHub 完全一致
✅ 零依赖安装只需 pip install ghpdf,无需安装 Pandoc、LaTeX 或浏览器
✅ 类 curl 的操作体验支持 -o(指定输出)和 -O(自动命名)等熟悉标志
✅ 批量处理友好ghpdf *.md -O 一键转换当前目录所有 Markdown 文件
✅ 管道支持可与 catecho 等命令组合,轻松集成到脚本中

快速上手

安装(推荐使用 pipx 隔离 CLI 工具)

pipx install ghpdf
# 或
pip install ghpdf

基础用法

# 转换单个文件,指定输出名
ghpdf README.md -o doc.pdf

# 自动命名(README.md → README.pdf)
ghpdf README.md -O

# 批量转换所有 .md 文件
ghpdf *.md -O

# 添加页码(底部居中)
ghpdf report.md -O -n

高级用法

# 从标准输入读取,输出到文件
echo "# Hello World" | ghpdf -o hello.pdf

# 通过管道输出 PDF 内容(可用于后续处理)
cat notes.md | ghpdf > notes.pdf

# 静默模式(适合自动化脚本)
ghpdf *.md -O -q

支持的 Markdown 语法

ghpdf 基于 GitHub 官方渲染规则,支持以下特性:

  • 标题、段落、列表(有序/无序/任务列表)
  • 代码块(带语法高亮)与行内代码
  • 表格(对齐、多行内容)
  • 块引用、水平线、删除线、粗体/斜体
  • 链接、图片(本地或远程)
  • 脚注、定义列表、缩写
  • 提示框(如 > [!NOTE])
  • 分页符(<div style="page-break-after: always;"></div>

所有样式均复刻 GitHub 渲染效果,无需额外 CSS 或模板。

适用场景

  • 技术文档交付:将 GitHub 项目的 README 或设计文档转为 PDF 发给非技术人员;
  • 学术笔记归档:把日常 Markdown 笔记批量转为带页码的 PDF 存档;
  • 自动化流程集成:在 CI/CD 或脚本中生成报告;
  • 简历/作品集生成:用熟悉的 Markdown 写简历,一键输出专业 PDF。

轻量、透明、开源

ghpdf 本身不依赖浏览器或复杂工具链,底层使用现代化 HTML-to-PDF 引擎,但对用户完全透明。你只需关心内容,排版交给它。

项目开源,代码可审计,无遥测、无广告、无隐藏依赖。

数据统计

相关导航

暂无评论

none
暂无评论...