rich-notebook-pdf-generator

Category: Daily Life | Uploader: LiuYihey | Downloads: 0 | Version: v1.0（Latest）

Generate structured PDF study notes with rich formatting.

Changelog: Source: GitHub https://github.com/LiuYihey/Live-time-tutorial

Directory Structure

Current level: src/builtin-skills/rich-notebook-pdf-generator/

📁 scripts/
- 📁 __pycache__/
  - 📄 notebook_pdf_writer.cpython-313.pyc 40.8 KB
- 📄 notebook_pdf_writer.py 33.4 KB
📄 SKILL.md 5.4 KB

SKILL.md

---
name: rich-notebook-pdf-generator
description: |
  Generate structured PDF study notes with rich formatting.
  Use when: user wants a detailed study note after a quiz or learning session.
version: 3.1.0
tags: [agent-skill, notebook, pdf, study-notes]
created: 2026-02-23
updated: 2026-03-02
---

# Rich Notebook PDF Generator

Generate structured, visually clear PDF study notes.

## Quick Start

1. Generate rich markdown content following the content structure below
2. Create a JSON payload file (auto-deleted after PDF generation)
3. Run the script to produce the PDF

```bash
python scripts/notebook_pdf_writer.py <payload.json> [out.pdf]
```

## Content Structure

Generate `contentMarkdown` using **numbered hierarchy** (`1.`, `1.1`, `1.2`, `2.`, `2.1` ...).

Use **bold** liberally to highlight key terms, definitions, and important conclusions.

Do NOT use checkboxes. Do NOT use bullet-only lists for main sections.

### 1. Terminology & Definitions

Use **bold** for each term being defined. Keep definitions concise.

```
## 1. Terminology & Definitions

**1.1 Term Name**: Clear one-line definition.

**1.2 Another Term**: Definition with `code` if technical.
```

### 2. Key Concepts & Principles

Explain the core ideas. Use **bold** for critical takeaways. Include common misconceptions.

```
## 2. Key Concepts & Principles

**2.1 Core Idea**: Explanation...

**2.2 Common Misconception**: Why X is wrong and Y is correct...
```

### 3. Practical Examples

Provide runnable code or step-by-step scenarios. Use code blocks for code.

```
## 3. Practical Examples

**3.1 Basic Example**

(code block or walkthrough)

**3.2 Real-world Scenario**

(application description)
```

### 4. Analogy & Memory Aids

Use everyday analogies to make concepts stick. Compare with similar concepts.

```
## 4. Analogy & Memory Aids

**4.1 Everyday Analogy**: "Think of X like..."

**4.2 Comparison**: X vs Y — key differences...
```

### 5. Summary Table

Always include at least one comparison or summary table. Tables are the most effective visual aid.

```
## 5. Summary Table

| Aspect | Option A | Option B |
|--------|----------|----------|
| Speed  | Fast     | Slow     |
| Memory | Low      | High     |
```

### 6. Process Flowchart

When applicable, describe a decision or process flow using a text-based flowchart with box-drawing characters. Flowcharts are automatically rendered as high-resolution images for perfect alignment.

```
## 6. Process Flowchart

┌─────────────┐
│ Start       │
└──────┬──────┘
       │
┌──────▼──────┐    Yes    ┌───────────┐
│ Condition?  ├──────────►│ Path A    │
└──────┬──────┘           └───────────┘
       │ No
┌──────▼──────┐
│ Path B      │
└─────────────┘
```

**Supported box-drawing characters**: `─ │ ┌ ┐ └ ┘ ├ ┤ ┬ ┴ ┼ ▼ ▲ ◄ ►` and all Unicode box-drawing range (U+2500-U+257F)

## Formatting Rules

1. **Bold liberally**: Every key term, definition name, and important conclusion should be **bold**
2. **Numbered hierarchy**: Use `1.`, `1.1`, `1.2`, `2.`, `2.1` for all sections and sub-sections
3. **Tables over lists**: Prefer comparison tables over long bullet lists
4. **No checkboxes**: Never use `[ ]` or `[x]` syntax
5. **No bullet-only sections**: Main content should use numbered structure, not just `-` lists
6. **Code blocks**: Use fenced code blocks with language tags for all code
7. **Flowcharts**: Use box-drawing characters (─│┌┐└┘├┤▼►) for process flows — auto-rendered as sharp images

## JSON Payload Format

```json
{
  "topic": "Your Topic Name",
  "summary": "Brief one-line description",
  "contentMarkdown": "## 1. Terminology...\n\n**1.1 Term**:...",
  "screenshotPath": "/path/to/screenshot.png",
  "tags": ["tag1", "tag2"],
  "design": {
    "theme": "clean",
    "accentColor": "#2563EB"
  }
}
```

### Fields

- **topic**: Note title (PDF filename)
- **summary**: One-line summary below title
- **contentMarkdown**: Main content following the structure above
- **screenshotPath**: Optional path to screenshot image, displayed as header image below title
- **tags**: Optional tags
- **design**: Optional styling — `theme`: "clean" | "warm" | "forest", `accentColor`: hex color

## PDF Generation Script

`scripts/notebook_pdf_writer.py` supports:
- Markdown rendering (headings, bold, lists, code blocks, quotes)
- Screenshot as header image (from `screenshotPath`)
- Markdown table detection and styled rendering
- **Flowchart rendering**: Text-based flowcharts are automatically converted to high-resolution PNG images using PIL (2x scale for sharp display), then embedded in the PDF
- Markdown image syntax support: `![alt](path)` for embedding images
- Theme support (clean/warm/forest) with accent colors
- Chinese font support (Microsoft YaHei, SimHei, SimSun)

**Dependencies**: `reportlab`, `Pillow` (`pip install reportlab Pillow`)

## Output

- **Default save location**: `~/Desktop/Notebook/{topic}.pdf`
- **JSON cleanup**: The payload JSON file is auto-deleted after PDF generation
- **Screenshot cleanup**: Screenshot file is auto-deleted after being embedded in PDF
- **Flowchart images**: Rendered in-memory and embedded directly; no intermediate files left on disk

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

rich-notebook-pdf-generator

Directory Structure

SKILL.md

Report

Notice