SKILL.md
Markdown to PDF Skill
将 Markdown 文档转换为专业的苹果设计风格 PDF 白皮书。
核心功能
- 专业排版:书籍级排版质量,自动处理分页、孤行寡行
- 苹果设计:SF 字体系统、现代简洁风格、专业配色
- 完整目录:自动提取章节结构,双列布局,可点击跳转
- Markdown 完美支持:代码块、表格、引用、列表等全部正确渲染
使用方法
基础用法
# 转换单个文件
python scripts/convert.py input.md
指定输出文件名
python scripts/convert.py input.md -o "我的白皮书.pdf"
自定义标题和作者
python scripts/convert.py input.md --title "技术白皮书" --author "花叔"
### Markdown 文档要求
你的 Markdown 文档应该遵循以下结构:
文档标题
1. 第一章
1.1 第一节
1.2 第二节
2. 第二章
2.1 第一节
**关键规则**:
- 主章节:`## 1. 标题`(数字 + 点 + 空格 + 标题)
- 子章节:`### 1.1 标题`(数字.数字 + 空格 + 标题)
- 这样才能正确提取目录
## 设计特点
### 封面设计
- 淡灰色渐变背景
- 大标题:64pt,简洁现代
- 副标题和元信息
### 目录设计
- 双列布局,单页展示
- 主章节粗体,子章节缩进
- 可点击跳转到对应章节
### 正文排版
- SF 字体系列(苹果设计语言)
- 行高 1.7,舒适阅读
- 章节自动分页
- 孤行寡行控制
### 代码块
- 浅灰背景 + 细边框
- 圆角 8px
- SF Mono 等宽字体
- 自动避免分页
### 表格
- 清晰网格线
- 浅灰表头
- 自动保留表头(长表格分页时)
## 配置选项
如果需要自定义样式,可以修改 `scripts/convert.py` 中的 CSS 变量:
主色调
PRIMARY_COLOR = '#06c' # 苹果蓝
TEXT_COLOR = '#1d1d1f' # 主文本黑色
GRAY_COLOR = '#86868b' # 浅灰色
字体大小
COVER_TITLE_SIZE = '64pt'
H2_SIZE = '22pt'
H3_SIZE = '17pt'
BODY_SIZE = '11pt'
## 常见问题
### Q: 目录为什么是空的?
A: 确保你的 Markdown 使用了正确的章节格式:
- `## 1. 标题` 而不是 `## 标题`
- `### 1.1 标题` 而不是 `### 标题`
### Q: 代码块显示不正确?
A: 确保使用三个反引号包裹:
def hello():
print("Hello")
### Q: 表格格式乱了?
A: 使用标准的 Markdown 表格语法:
| 列1 | 列2 |
|---|---|
| 值1 | 值2 |
### Q: 如何修改字体?
A: 编辑 `scripts/convert.py` 中的 CSS,修改 `font-family` 属性。
### Q: 生成的 PDF 太大?
A: 检查是否有大量图片,考虑压缩图片或使用外链。
## 依赖安装
首次使用需要安装 Python 依赖:
pip3 install markdown2 weasyprint
如果遇到 WeasyPrint 安装问题(macOS):
brew install pango
pip3 install weasyprint
## 示例
### 生成技术文档
python scripts/convert.py tech-guide.md -o "技术指南.pdf"
### 生成白皮书
python scripts/convert.py whitepaper.md --title "产品白皮书" --author "团队"