关于 slides-generator
slides-generator 可将 Markdown 内容制作成 Hummingbot 品牌风格的 PDF 演示文稿,适用于需要生成幻灯片的用户。它支持 Mermaid 图表,并能在文字与图表并列时采用双栏布局。
主要功能
- 01从 Markdown 生成 PDF
- 02渲染 Mermaid 图表
- 03自动双栏布局
- 04生成前确认幻灯片提纲
- 05编辑现有幻灯片内容
适用场景
- 01根据 Markdown 制作技术演示文稿
- 02展示架构图和流程图
- 03修改现有源内容中的幻灯片
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ hummingbot/ skills --skill slides-generator安装后在 Claude Code 中输入/slides-generator确认已加载。
附带文件scripts/generate_slides.sh
详细介绍
slides-generator
根据 Markdown 内容创建 Hummingbot 品牌的 PDF 演示文稿。支持双栏布局,并可渲染 Mermaid 图表,用于展示技术架构和流程图。
工作流
步骤 1:获取 Markdown 内容
请用户提供 Markdown 文件或粘贴 Markdown 内容。内容应遵循以下格式:
# Presentation Title
## 1. First Slide Title
Content for the first slide. Can include:
- Bullet points
- **Bold text** and *italic text*
- Code blocks
## 2. Second Slide Title
More content here.
## 3. Third Slide Title
And so on...
格式规则:
# Title= 演示文稿标题(可选,会成为标题页)## N. Slide Title= 新建幻灯片(N 为幻灯片编号)- 每个
##标题下方的内容会成为幻灯片内容 - 支持 Markdown 格式:列表、粗体、斜体、代码块、链接
步骤 2:解析并确认
生成 PDF 之前,先解析 Markdown 并向用户展示摘要:
📊 Slide Outline:
1. First Slide Title
2. Second Slide Title
3. Third Slide Title
...
Total: X slides
Please confirm to proceed with PDF generation, or provide edits.
等待用户确认后再继续。
步骤 3:生成 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>"
或者,如果用户提供的是内联内容,请先将其保存到临时文件:
# Save content to temp file
cat > /tmp/slides_content.md << 'SLIDES_EOF'
<markdown_content_here>
SLIDES_EOF
# Generate PDF
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
步骤 4:交付结果
生成完成后,告知用户:
- 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 代码。
用户输入格式
用户可以这样描述:
mermaid: A flowchart showing User Interface connecting to Condor and MCP Agents,
both connecting to Hummingbot API (highlighted), then to Client, then to Gateway
转换为 Mermaid
将描述转换为规范的 Mermaid 语法:
\`\`\`mermaid
flowchart TB
A[User Interface] --> B[Condor]
A --> C[MCP Agents]
B --> D[Hummingbot API]
C --> D
D --> E[Hummingbot Client]
E --> F[Gateway]
style D fill:#00D084,color:#fff
\`\`\`
图表类型
flowchart TD- 自上而下的流程图flowchart LR- 从左到右的流程图sequenceDiagram- API 和交互流程classDiagram- 面向对象设计erDiagram- 数据库架构
高亮
使用 style NodeName fill:#00D084,color:#fff 以 Hummingbot 绿色进行高亮。
要求
Mermaid 图表需要 Mermaid CLI:
npm install -g @mermaid-js/mermaid-cli
代码块
ASCII 艺术图、代码片段或预格式化文本请使用常规的 \``` 代码块:
\`\`\`
Price
^
| [BUY] --- Level 3
| [BUY] --- Level 2
| [BUY] --- Level 1
+-------------------> Time
\`\`\`
代码块会以等宽字体显示在灰色背景上。
双栏布局
如果幻灯片同时包含项目符号和图表,则会自动以双栏布局显示:
- 左栏:文本内容
- 右栏:图表
## 4. How It Works
Key features:
- Automated order placement
- Dynamic position management
- Risk-controlled execution
- Real-time monitoring
mermaid: flowchart showing Market Data to Strategy to Orders
翻译后:
## 4. How It Works
Key features:
- Automated order placement
- Dynamic position management
- Risk-controlled execution
- Real-time monitoring
\`\`\`mermaid
flowchart TD
A[Market Data] --> B[Strategy]
B --> C[Orders]
style B fill:#00D084,color:#fff
\`\`\`
Markdown 示例
# Q4 Product Update
## 1. Overview
Today we'll cover:
- Product milestones
- Key metrics
- Roadmap preview
## 2. Architecture
Our system components:
- User-facing interfaces
- Core API layer
- Exchange connectivity
mermaid: flowchart showing UI to API (highlighted) to Gateway
## 3. Key Metrics
| Metric | Q3 | Q4 | Change |
|--------|----|----|--------|
| Users | 10K | 15K | +50% |
| Revenue | $100K | $150K | +50% |
## 4. Q1 Roadmap
1. Mobile app launch
2. Enterprise tier
3. International expansion
## 5. Questions?
Thank you!
Contact: [email protected]
翻译 mermaid: 描述后:
## 2. Architecture
Our system components:
- User-facing interfaces
- Core API layer
- Exchange connectivity
\`\`\`mermaid
flowchart TD
A[UI] --> B[API]
B --> C[Gateway]
style B fill:#00D084,color:#fff
\`\`\`
依赖项
脚本会检查以下依赖项,并在需要时进行安装:
- Python 3
fpdf2Python 包(用于生成 PDF)
故障排除
| 问题 | 解决方案 |
|---|---|
| "Python not found" | 安装 Python 3:brew install python3(macOS)或 apt install python3(Linux) |
| "fpdf2 not installed" | 运行:pip3 install fpdf2 |
| "Permission denied" | 检查输出目录的写入权限 |
| "Empty PDF" | 确认 Markdown 格式遵循 ## N. Title 模式 |
脚本
| 脚本 | 用途 |
|---|---|
generate_slides.sh | PDF 生成主脚本 |