1. 项目简介

ebook-treasure-chest(电子书下载宝库)是一个中文电子书下载链接导航库,GitHub 已收获 15,000+ Stars 和 2,100+ Forks,是目前 GitHub 上最大的中文电子书导航项目之一。它汇集了帆书 app(原樊登读书)、微信读书、京东读书、喜马拉雅等读书平台的大部分电子书资源,每本书提供 epub、mobi、azw3 三种常见格式,涵盖 150+ 个分类。

核心特性:

  • 海量资源索引:按标签分类整理电子书下载链接
  • 多格式支持:每本书提供 epub、mobi、azw3 三种格式
  • 实时在线搜索:GitHub Pages 提供实时搜索和多关键词搜索功能
  • 自动同步脚本:内置同步脚本和 GitHub Actions 工作流

重要说明:该项目本质上是一个资源导航库,并非需要编译运行的软件系统。因此,本部署教程的核心是:如何将项目克隆到本地,以及如何部署属于自己的 GitHub Pages 搜索站点

2. 部署前准备

2.1 环境要求

由于这是一个资源导航类项目,部署需求非常轻量:

组件 要求 说明
Git 任意版本 克隆仓库
GitHub 账号 免费账号即可 用于 Fork 和部署 Pages
浏览器 任意 访问在线搜索页面
磁盘空间 约 7MB+ 仅用于克隆仓库

2.2 部署方式概览

方式 适用场景 优势
在线搜索(零部署) 普通用户 无需任何操作,直接访问
Fork + Pages 部署 自建搜索站点 拥有独立的搜索页面
本地克隆 离线使用 完整数据保存到本地

3. 方式一:在线搜索(零部署,推荐)

这是最简单的方式,无需任何部署操作,直接访问官方 GitHub Pages 页面即可。

3.1 访问地址

text

1
https://jbiaojerry.github.io/ebook-treasure-chest/

3.2 使用方法

  • 实时搜索:输入书名、作者或分类关键词,即时显示匹配结果
  • 多关键词搜索:支持同时搜索多个关键词(用空格分隔)
  • 按需查找:职场、创业、技术、投资、心理学等专业领域
  • Ctrl+F:在 GitHub 页面使用浏览器搜索功能

搜索技巧

  • 按书名搜:中文书名最有效
  • 按作者搜:如“刘慈欣”、“金庸”
  • 按分类搜:如“心理学”、“互联网”、“Python”
  • 多关键词:空格分隔,AND 逻辑
  • 热门分类优先:文学、历史、科普三大类

4. 方式二:Fork 并部署独立 GitHub Pages

如果你希望拥有一个独立的搜索站点(例如避免官方站点访问受限),可以 Fork 项目并部署自己的 GitHub Pages。

4.1 Fork 项目

  1. 访问 https://github.com/jbiaojerry/ebook-treasure-chest
  2. 点击右上角的 Fork 按钮
  3. 选择你的账号作为目标,等待 Fork 完成

4.2 启用 GitHub Pages

  1. 进入你 Fork 后的仓库
  2. 点击 Settings(设置)
  3. 在左侧菜单中找到 Pages
  4. Build and deployment 下:
    • Source 选择 Deploy from a branch
    • Branch 选择 main(或 master)
    • Folder 选择 / (root)
  5. 点击 Save 保存

4.3 访问你的站点

保存后等待 1-5 分钟,访问:

text

1
https://你的用户名.github.io/ebook-treasure-chest/

提示:GitHub Pages 通常 1-5 分钟生效,最长不超过 30 分钟。GitHub 自动提供 HTTPS 支持。

4.4 绑定自定义域名(可选)

如果你有自己的域名,可以绑定到 GitHub Pages:

  1. 在仓库根目录创建 CNAME 文件,内容填写你的域名:

    text

    1
    www.yourdomain.com
  2. 在域名服务商处添加 DNS 记录:

    • A 记录:指向 185.199.108.153
    • 或 CNAME 记录:指向 你的用户名.github.io
  3. 在仓库 Settings → Pages → Custom domain 中填写域名

5. 方式三:本地克隆部署

适合需要离线使用或进行二次开发的用户。

5.1 克隆仓库

1
2
git clone https://github.com/jbiaojerry/ebook-treasure-chest.git
cd ebook-treasure-chest

5.2 查看仓库结构

克隆后的主要文件结构如下:

text

1
2
3
4
5
6
7
8
ebook-treasure-chest/
├── .github/ # GitHub Actions 工作流配置
├── docs/ # 文档和页面资源
├── md/ # Markdown 电子书索引文件
├── scripts/ # 同步脚本
├── README.md # 项目说明
├── max_book_id_found.txt # 最大书籍 ID 记录
└── sponsors.md # 赞助人名单

5.3 本地访问

克隆后,直接在浏览器中打开 docs/index.html(如果存在)即可使用搜索功能。或者,你可以运行一个简单的本地 HTTP 服务器:

1
2
3
4
5
# Python 3
python -m http.server 8000

# 或 Node.js
npx serve

然后访问 http://localhost:8000

6. 项目维护(进阶)

如果你是项目维护者或希望了解自动同步机制,可以参考以下内容。

6.1 GitHub Actions 自动同步

项目包含自动同步脚本和 GitHub Actions 工作流,用于自动更新电子书索引。相关工作流位于 .github/ 目录中。

6.2 同步脚本

scripts/ 目录包含同步脚本,用于从数据源抓取和更新电子书信息。

6.3 自动部署流程

GitHub Pages 的自动部署机制如下:

  1. 推送代码到 main 分支
  2. GitHub Actions 自动触发构建
  3. 构建产物发布到 GitHub Pages

7. 常见问题与解决方案

7.1 GitHub Pages 无法访问

问题:Fork 后部署的 Pages 无法访问。

解决方案

  • 确认仓库的 Settings → Pages 中已正确配置分支和目录
  • 等待 1-5 分钟让部署生效
  • 检查仓库是否为 Public(私有仓库的 Pages 需要付费账号)

7.2 搜索结果不更新

问题:在线搜索的数据不是最新的。

解决方案:GitHub Pages 页面是从仓库内容构建的,如果官方仓库更新了数据,你需要重新 Fork 或同步上游仓库的更新。

7.3 克隆仓库速度慢

问题:仓库较大(7MB+),克隆速度慢。

解决方案

  • 使用 --depth 1 浅克隆:

    1
    git clone --depth 1 https://github.com/jbiaojerry/ebook-treasure-chest.git
  • 或直接使用在线搜索,无需克隆

8. 使用注意事项

8.1 版权与合规提醒

根据第三方评测,该项目存在版权与合规方面的灰色地带,下载传播前需自行评估。建议:

  • 仅将下载内容用于个人学习
  • 不要公开传播或用于商业用途
  • 支持正版图书,购买合法授权

8.2 仓库体积较大

仓库包含 7MB+ 的索引文件,不推荐全量克隆。如果你只是偶尔查找书籍,建议直接使用在线搜索页面。

9. 部署架构总结

部署方式 适用场景 操作复杂度 访问地址
在线搜索 普通用户 零操作 官方 GitHub Pages
Fork + Pages 自建站点 简单 你的用户名.github.io/ebook-treasure-chest
本地克隆 离线使用/开发 中等 localhost

ebook-treasure-chest 的部署本质上非常简单——它不是一个需要编译运行的程序,而是一个资源索引库 + 静态搜索页面。对于大多数用户,直接访问官方 GitHub Pages 在线搜索页面即可满足需求;如果需要独立站点,Fork 后启用 GitHub Pages 几分钟即可完成部署。核心价值在于其整理的 150+ 分类、三格式全收录的电子书导航体系,以及便捷的实时搜索功能。