mcpField
M
markdown-to-epub-converter

markdown-to-epub-converter

github.com/smerchek文档处理170700 次安装54 周前更新
代码仓库

关于 markdown-to-epub-converter

此技能将原始 Markdown 或文件路径中的文档转换为结构化的 EPUB3 电子书,适用于整理文章、研究资料或对话摘要。它按 H1 划分章节,并生成目录与导航文档。

主要功能

  1. 01支持文本和文件路径输入
  2. 02按 H1 自动划分章节
  3. 03生成目录和 EPUB3 导航
  4. 04保留链接、列表和代码等格式
  5. 05支持自定义书名、作者和语言

适用场景

  1. 01将博客文章制作为电子书
  2. 02整理研究笔记供阅读
  3. 03保存对话摘要为 EPUB

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/smerchek/claude-epub-skill --skill markdown-to-epub-converter

安装后在 Claude Code 中输入/markdown-to-epub-converter确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

REFERENCE.md
requirements.txt
scripts/
epub_generator.py
markdown_processor.py

详细介绍

Markdown 转 EPUB 转换器技能

此技能可将 Markdown 文档转换为专业的 EPUB 电子书文件。适用于将研究文档、博客文章、文章或聊天对话摘要转换为便于携带且不受设备限制的电子书格式。

概述

此技能接受多种格式的 Markdown 内容,并生成格式规范的 EPUB3 文件,可在所有主流电子书阅读器上使用,包括:

  • Apple Books
  • Amazon Kindle(通过 Kindle for Mac/Windows/iOS/Android)
  • Google Play Books
  • Kobo 及其他 EPUB 阅读器
  • 任何标准 EPUB 阅读器

输入格式

选项 1:原始 Markdown 文本

直接在消息中提供 Markdown 内容:

Convert this markdown to EPUB:
# My Book Title
## Chapter 1
This is chapter one content...
选项 2:文件路径

提供要转换的 Markdown 文件路径。

工作原理

  1. Markdown 解析:分析 Markdown,并自动:

    • 将 H1 标题(#)视为章节边界
    • 将 H2 标题(##)视为章节内的小节标题
    • 保留格式(粗体、斜体、链接、列表、代码块)
  2. 结构生成:创建规范的 EPUB 结构:

    • 根据章节自动生成目录
    • 导航文档(EPUB3 标准)
    • 元数据(标题、语言等)
  3. 文件创建:生成可供下载和使用的有效 EPUB3 文件

使用示例

示例 1:转换博客文章

“将这篇 Markdown 博客文章转换为 EPUB:

如何构建简单的 Web 服务器

简介

……内容……”

示例 2:转换研究摘要

“我有 Markdown 格式的研究笔记。请将其转换为 EPUB 电子书。内容如下:

研究项目:机器学习基础

第 1 章:基础知识

……”

示例 3:转换聊天摘要

“将我们目前为止的对话总结为 Markdown,并转换为 EPUB,供日后参考。”

输出

此技能会生成可下载的 EPUB 文件,其中包括:

  • 专业排版
  • 自动生成的目录
  • 规范的章节结构
  • 支持以下 Markdown 格式元素:
    • 标题(所有级别)
    • 粗体和斜体文本
    • 超链接
    • 列表(有序和无序)
    • 代码块和行内代码
    • 引用块
    • 水平分隔线

支持的 Markdown 元素

元素Markdown支持情况备注
标题# H1 到 ###### H6完全支持自动生成目录
粗体**text** 或 __text__完全支持
斜体*text* 或 _text_完全支持
链接[text](url)完全支持可在电子书中点击
列表- item 或 1. item完全支持支持嵌套列表
代码块```language增强支持已准备好语法高亮,使用等宽字体
行内代码 code 增强支持带样式的背景和边框
表格Markdown 表格增强支持带样式的表头和交替行
引用块> quote完全支持左侧带样式边框
水平分隔线--- 或 ***完全支持

高级功能

增强的代码块支持

代码块经过精美排版,具有以下特点:

  • 优质等宽字体:SF Mono、Monaco、Fira Code、Consolas 等
  • 带样式的背景:浅灰色背景,带蓝色强调边框
  • 语言检测:在 ``` 后指定语言,以便未来支持语法高亮
  • 正确转义:安全转义 HTML 字符
  • 溢出处理:长行可水平滚动

示例:

def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)
增强的表格支持

表格采用专业样式渲染:

  • 带样式的表头:蓝色背景,白色文字
  • 交替行:斑马纹效果,便于阅读
  • 单元格内边距:留出舒适间距,方便阅读
  • 行内格式:单元格中可使用代码、粗体、斜体和链接
  • 响应式布局:表格可适配不同屏幕尺寸

示例:

功能状态备注
标题✓完全支持
代码✓增强样式
表格✓专业布局
自定义标题和元数据

你可以指定 EPUB 元数据:

  • 书名(默认为第一个 H1 标题)
  • 作者姓名
  • 语言
  • 出版日期
章节组织

章节会自动从以下内容中检测:

  • H1 标题(#)作为主要章节分隔
  • H1 标题之间的逻辑内容分区
  • 章节之间自动分页
样式

生成的 EPUB 使用简洁易读的默认样式,并且:

  • 遵循读者的字体偏好
  • 适用于所有屏幕尺寸
  • 保持适当的间距和层级
  • 包含合适的页边距和内边距

技术详情

  • 格式:EPUB3(兼容所有现代阅读器)
  • 编码:UTF-8
  • HTML 版本:XHTML 1.1
  • CSS 支持:响应式样式

下载 EPUB

生成后,文件即可下载。你可以:

  1. 将 EPUB 下载到电脑
  2. 使用你喜欢的电子书阅读器打开
  3. 传输到 Kindle、iPad 或其他设备
  4. 通过电子邮件或云端直接上传到 Kindle

最佳效果提示

  1. 使用规范的 Markdown 结构:当 Markdown 遵循标准约定(标题使用 H1,章节使用 H2)时,此技能效果最佳

  2. 清晰划分章节:使用 H1 标题明确标记章节分界

  3. 使用描述性标题:标题会成为目录,因此应清晰且具有描述性

  4. 组织内容:在标题之间合理安排内容

  5. 使用支持的格式:使用基本的 Markdown 格式,以确保在所有阅读器上获得最佳兼容性

故障排除

无法打开 EPUB:确保 Markdown 格式正确。检查链接中的括号是否匹配,以及语法是否正确。

目录为空:确保 Markdown 中包含用于定义章节的 H1 标题。

格式显示不同:EPUB 阅读器会应用自己的字体和样式。这是正常且符合预期的行为。

脚本

  • epub_generator.py - EPUB 文件创建和格式处理的核心脚本
  • markdown_processor.py - Markdown 解析和结构提取脚本

未来增强

  • 使用自定义图片自动生成封面
  • 针对 Kindle 的优化(.mobi 格式)
  • 根据用户偏好自定义 CSS 样式
  • 合并多个文档
  • 嵌入和优化图片
  • 支持高级元数据

评论

支持 Markdown