markdown-to-epub-converter

Files (5)

• REFERENCE.md
• SKILL.md
• requirements.txt
• epub_generator.py · scripts/
• markdown_processor.py · scripts/

SKILL.md (first lines)

# Markdown to EPUB Converter Skill

This skill transforms markdown documents into professional EPUB ebook files. Perfect for converting research documents, blog posts, articles, or chat conversation summaries into portable, device-agnostic ebook formats.

## Overview

The skill accepts markdown content in multiple formats and generates a properly formatted EPUB3 file that works across all major ebook readers including:
- Apple Books
- Amazon Kindle (via Kindle for Mac/Windows/iOS/Android)
- Google Play Books
- Kobo and other EPUB readers
- Any standard EPUB reader

## Input Formats

### Option 1: Raw Markdown Text
Provide markdown content directly in your message:

```
Convert this markdown to EPUB:
# My Book Title
## Chapter 1
This is chapter one content...
```

### Option 2: File Path
Provide a path to a markdown file to be converted.

## How It Works

1. **Markdown Parsing**: Analyzes your markdown and automatically:
   - Treats H1 headers (`#`) as chapter boundaries
   - Treats H2 headers (`##`) as section headings within chapters
   - Preserves formatting (bold, italic, links, lists, code blocks)

2. **Structure Generation**: Creates proper EPUB structure:
   - Automatic table of contents from chapters
   - Navigation document (EPUB3 standard)
   - Metadata (title, language, etc.)

3. **File Creation**: Generates a valid EPUB3 file ready for download and use

## Usage Examples

### Example 1: Convert a Blog Post
"Convert this markdown blog post to EPUB:
# How to Build a Simple Web Server
## Introduction
...content..."

### Example 2: Convert a Research Summary
"I have research notes in markdown format. Convert them to an EPUB ebook. The content is:
# Research Project: Machine Learning Basics
## Chapter 1: Fundamentals
..."

### Example 3: Convert a Chat Summary
"Summarize our conversation so far as markdown and convert it to an EPUB for reference"

## Output

The skill generates a downloadable EPUB file that includes:
- Professional formatting
- Automatic table of contents
- Proper chapter structure
- Support for markdown formatting elements:
  - Headers (all levels)
  - Bold and italic text
  - Hyperlinks
  - Lists (ordered and unordered)
  - Code blocks and inline code
  - Blockquotes
  - Horizontal rules

## Markdown Elements Supported

| Element | Markdown | Support | Notes |
|---------|----------|---------|-------|
| Headers | `# H1` through `###### H6` | Full | Auto TOC generation |
| Bold | `**text**` or `__text__` | Full | |
| Italic | `*text*` or `_text_` | Full | |
| Links | `[text](url)` | Full | Clickable in ebooks |
| Lists | `- item` or `1. item` | Full | Nested lists supported |
| Code blocks | ` ```language ` | **Enhanced** | Syntax highlighting ready, monospace fonts |
| Inline code | ` `code` ` | **Enhanced** | Styled background, borders |
| Tables | Markdown tables | **Enhanced** | Styled headers, alternating rows |
| Blockquotes | `> quote` | Full | Styled with left border |
| Horizontal rule | `---` or `***` | Full | |

## Advanced Features

### Enhanced Code Block Support

Code blocks are beautifully formatted with:
- **Premium monospace fonts**: SF Mono, Monaco, Fira Code, Consolas, and more
- **Styled backgrounds**: Subtle gray background with blue accent border
- **Language detection**: Specify language after ` ``` ` for future syntax highlighting
- **Proper escaping**: HTML characters are safely escaped
- **Overflow handling**: Horizontal scrolling for long lines

Example:
```python
def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)
```

### Enhanced Table Support

Tables are rendered with professional styling:
- **Styled headers**: Blue background with white text
- **Alternating rows**: Zebra striping for readability
- **Cell padding**: Comfortable spacing for easy reading
- **Inline formatting**: Code, bold, italic, and links work in cells
- **Responsive**: Tables adapt to different screen sizes

Example:
| Feature | Status | Notes |

From smerchek/claude-epub-skill, MIT.