关于 pdf-best-practices
用于编写可可靠渲染为 PDF 的 HTML 的参考技能,适合开发者和文档作者。它围绕 Puppeteer 流程整理页面布局、表格、图片及不同文档类型的指南。
主要功能
- 01HTML 文档结构指南
- 02分页与页面分隔规则
- 03PDF 表格和图片格式
- 04页眉、页脚与页码
- 05按文档类型提供指南
适用场景
- 01将报告或发票制作为 PDF
- 02避免表格行在分页时被拆开
- 03安排图片与说明文字跨页布局
- 04生成 PDF 前检查 HTML
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ pdfnoodle/ pdf-best-practices --skill pdf-best-practices安装后在 Claude Code 中输入/pdf-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSEpackage.jsonREADME.mdresources/document-setup.mdcolors.mddocument-types.mdpage-breaks.mdheaders-footers.mdimages.mdcontent-density.mdtables.md详细介绍
PDF 最佳实践技能
创建可完美呈现为 PDF 文档的 HTML 的全面指南。
┌─────────────────────────────────────────────────────────────────────────────┐
│ HTML to PDF Pipeline │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ ┌──────────┐ ┌──────────────┐ ┌─────────────┐ ┌──────────────┐ │
│ │ HTML │───▶│ PDF Engine │───▶│ Pagination │───▶│ Final PDF │ │
│ │ Content │ │ (Puppeteer) │ │ & Layout │ │ Document │ │
│ └──────────┘ └──────────────┘ └─────────────┘ └──────────────┘ │
│ │ │ │
│ ▼ ▼ │
│ ┌──────────┐ ┌─────────────┐ │
│ │ CSS │ │ Page Breaks │ │
│ │ Styles │ │ & Margins │ │
│ └──────────┘ └─────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
快速参考
| 我想要…… | 阅读此内容 |
|---|---|
| 正确设置文档结构 | 文档设置 |
| 控制分页 | 分页 |
| 设置 PDF 表格格式 | 表格 |
| 正确处理图片 | 图片 |
| 优化内容密度 | 内容密度 |
| 设置颜色和背景 | 颜色与背景 |
| 添加页眉、页脚和页码 | 页眉与页脚 |
| 创建特定类型的文档 | 文档类型 |
从这里开始
要构建新的 PDF 文档?
要处理数据表格?
文档中有图片?
要创建特定类型的文档?
- 查看文档类型,了解特定类型的指南
- 可用类型:发票、报告、证书、信函、表格密集型、图片密集型
默认配置
生成 PDF 时,请使用以下推荐参数:
{
"format": "A4",
"margin": {
"top": "40px",
"right": "40px",
"bottom": "40px",
"left": "40px"
},
"printBackground": true
}
快速检查清单
生成任何 PDF 之前:
- HTML 结构完整,包含 DOCTYPE、html、head、body
- CSS 包含带有 A4 尺寸的
@page规则 - body 设置了
-webkit-print-color-adjust: exact - 所有图片都明确指定了宽度和高度
- 表格使用 thead/tbody 结构
- 在逻辑内容块上设置
page-break-inside: avoid - 标题设置
page-break-after: avoid - 没有过多空白或内容稀疏的页面
- 字号不小于 9pt
- 颜色对比度足够
- pdfParams 包含 format、margins 和
printBackground: true
评论
支持 Markdown