booktools
v1.0.5
Published
跨平台的epub电子书处理工具集 - 转换epub为markdown并整理文件结构
Maintainers
Readme
📚 BookTools - epub电子书处理工具
一键将epub文件转换为整理好的markdown文档,简单易用,无需复杂配置
🔗 相关资源
- 📖 AI驱动的书籍知识图谱制作完整指南 - 详细的制作教程
- 🎯 Demo项目代码库 - 完整的演示项目和案例
🚀 2步快速上手
第一步:安装工具
npm install -g booktools📦 会自动安装epub2md依赖,无需额外配置
第二步:处理你的第一本书
# 把epub文件放在任意目录,然后运行:
booktools process 我的书籍.epub
# 🎉 完成!工具会自动:
# ✅ 转换epub为markdown章节
# ✅ 合并成完整文档
# ✅ 清理格式
# ✅ 整理文件夹结构第三步:查看结果
我的书籍/
├── books/ # 📁 原始章节文件
│ ├── 第一章.md
│ ├── 第二章.md
│ └── 我的书籍.md.backup
└── wiki/ # 📁 整理后的文件
├── 我的书籍.md # 📄 完整的书籍内容
└── GEMINI.md # 📄 AI分析模板 (可用template命令生成)就这么简单! 现在您可以用AI工具分析书籍内容,或者直接阅读整理好的markdown文档。
📖 更多用法
常用命令
# 查看帮助
booktools --help
# 指定输出目录
booktools process 书籍.epub ./输出文件夹
# 跳过引用清理(保留原始格式)
booktools process 书籍.epub --no-clean-references
# 重新整理已处理的书籍
booktools organize 书籍名称
# 复制模板文件到当前目录
booktools template批量处理
# Windows PowerShell
Get-ChildItem *.epub | ForEach-Object { booktools process $_.Name }
# Linux/macOS
for file in *.epub; do booktools process "$file"; done独立工具
# 合并文件夹中的所有文件
book-merge ./章节目录 合并文件.md
# 清理markdown中的引用格式
book-clean 文件.md
# 整理书籍文件夹
book-organize 书籍名称🛠️ 问题解决
安装问题
问题:booktools: command not found
# 解决方案:重新安装
npm install -g booktools
# 然后重启终端问题:epub2md: command not found
# 解决方案:重新安装booktools(会自动安装epub2md)
npm install -g booktools问题:权限错误(Linux/macOS)
# 解决方案:使用用户级安装
npm install -g booktools --prefix ~/.local问题:Windows执行策略错误
# 解决方案:以管理员身份运行PowerShell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser验证安装
运行这些命令检查是否安装成功:
booktools --version # 应该显示版本号
epub2md --help # 应该显示帮助信息卸载
npm uninstall -g booktools📋 命令参考
booktools process
booktools process <epub文件> [输出目录] [选项]
选项:
--no-clean-references 跳过引用清理
--help 显示帮助
示例:
booktools process 三国演义.epub
booktools process 红楼梦.epub ./books
booktools process 水浒传.epub --no-clean-referencesbooktools organize
booktools organize <书籍名称> [选项]
选项:
--dir <目录> 指定书籍文件夹路径
--help 显示帮助
示例:
booktools organize 三国演义
booktools organize 红楼梦 --dir ./booksbooktools template
booktools template [模板名称] [目标目录]
参数:
模板名称 要复制的模板文件名 (默认: GEMINI.md)
目标目录 复制到的目标目录 (默认: 当前目录)
选项:
--help 显示帮助
示例:
booktools template # 复制GEMINI.md到当前目录
booktools template GEMINI.md # 指定模板文件名
booktools template GEMINI.md ./docs # 复制到指定目录book-merge
book-merge <输入目录> <输出文件>
示例:
book-merge ./chapters book.md
book-merge . complete.mdbook-clean
book-clean [文件或目录] [选项]
选项:
--no-backup 不创建备份
--recursive, -r 递归处理子目录
--help 显示帮助
示例:
book-clean book.md
book-clean . --recursive
book-clean ./books --no-backup✨ 特性
- 🚀 一键安装 - npm全局安装,无需复杂配置
- 📚 epub转换 - 自动转换为markdown格式
- 🧹 智能清理 - 去除引用格式,保留纯净内容
- 📁 自动整理 - 创建规范的目录结构
- 📝 模板管理 - 内置AI分析模板,快速复制使用
- 🔧 跨平台 - Windows、macOS、Linux完全兼容
- ⚡ 高效处理 - 批量处理多个文件
🙏 鸣谢
感谢以下开源项目和贡献者:
- epub2md - 提供了epub转markdown的核心功能
- 所有使用者和贡献者 - 感谢您的反馈和建议,让工具不断完善
🤝 贡献与反馈
📄 许可证
MIT License - 自由使用,欢迎贡献
开始您的电子书整理之旅! 📚✨
💡 提示:处理完成后,可以将整理好的markdown文档导入到Obsidian、Notion等知识管理工具中,或者使用AI工具进行深度分析。
