用途
slides-generator 用于从 markdown 内容创建 Hummingbot 品牌风格的 PDF 演示幻灯片。适用于演示文稿、deck,以及包含专业排版的技术文档。
主要能力
- 将 markdown 转换为 PDF 幻灯片。
- 支持 Mermaid 图表渲染,可用于技术架构和流程图。
- 支持两栏布局:当幻灯片同时包含要点和图表时,自动以两栏显示,左栏为文本内容,右栏为图表。
- 支持 markdown 格式:列表、粗体、斜体、代码块、链接、表格。
- 支持编辑已有幻灯片:可编辑特定幻灯片内容、新增幻灯片、删除幻灯片、重排幻灯片。
- 生成前会解析 markdown 并向用户展示幻灯片大纲以确认。
使用方式
第一步:获取 Markdown 内容
让用户提供 markdown 文件或粘贴 markdown 内容。内容格式要求:
# Title表示演示标题(可选,会成为标题幻灯片)。## N. Slide Title表示新幻灯片(N 为幻灯片编号)。- 每个
##标题下的内容成为该幻灯片内容。
在生成 PDF 前,先解析 markdown 并向用户展示摘要,等待用户确认后再继续。
第三步:生成 PDF
运行生成脚本:
bash <(curl -s https://raw.githubusercontent.com/hummingbot/skills/main/skills/slides-generator/scripts/generate_slides.sh) \
--input "<markdown_file_or_content>" \
--output "<output_pdf_path>"
如果用户提供的是内联内容,先保存到临时文件:
cat > /tmp/slides_content.md << 'SLIDES_EOF'
<markdown_content_here>
SLIDES_EOF
bash <(curl -s https://raw.githubusercontent.com/hummingbot/skills/main/skills/slides-generator/scripts/generate_slides.sh) \
--input /tmp/slides_content.md \
--output ~/slides_output.pdf
第四步:交付结果
生成后告知用户 PDF 文件位置、生成的幻灯片数量,并可询问是否需要打开或查看 PDF。
编辑已有幻灯片
如果用户想编辑之前生成的 PDF 幻灯片:读取原始 markdown 或查看 PDF,询问用户所需更改,应用到 markdown,重新生成 PDF。可使用 --edit 标志更新特定幻灯片而无需全部重新生成:
bash <(curl -s https://raw.githubusercontent.com/hummingbot/skills/main/skills/slides-generator/scripts/generate_slides.sh) \
--input "<updated_markdown>" \
--output "<same_pdf_path>" \
--edit
图表
用户可用自然语言通过 mermaid: 语法描述图表。在生成 PDF 前,需要将这些描述转换为 Mermaid 代码。
支持的图表类型:
flowchart TD自上而下流程图flowchart LR从左到右流程图sequenceDiagramAPI 与交互流程classDiagram面向对象设计erDiagram数据库模式
高亮方式:使用 style NodeName fill:#00D084,color:#fff 实现 Hummingbot 绿色高亮。
Mermaid 图表需要 Mermaid CLI:
npm install -g @mermaid-js/mermaid-cli
代码块
使用常规 ``` 代码块放置 ASCII 图、代码片段或预格式化文本。代码块以等宽字体在灰色背景上渲染。
依赖
脚本会检查并在需要时安装:
- Python 3
- fpdf2 Python 包(用于 PDF 生成)
排障
- “Python not found”:安装 Python 3,macOS 可用
brew install python3,Linux 可用apt install python3。 - “fpdf2 not installed”:运行
pip3 install fpdf2。 - “Permission denied”:检查输出目录的写权限。
- “Empty PDF”:确认 markdown 格式遵循
## N. Title模式。
脚本
generate_slides.sh:主 PDF 生成脚本。
适用场景
适合制作带品牌风格的演示幻灯片、技术架构说明、流程图文档,以及包含图表与文本混排的专业演示材料。
限制
Mermaid 图表渲染需额外安装 Mermaid CLI。其他限制资料暂未提供。