WePub 是一个基于 Next.js 构建的现代网页内容阅读优化工具。它能将任何网页转换为清晰、易读的文章格式，支持批量抓取和多种格式导出，让您的阅读体验更加舒适。
- 网页内容优化与阅读体验提升
- 批量网页抓取与内容整合
- RSS源订阅与内容抓取
- 多种格式导出（HTML、PDF、EPUB、Markdown）
- 暗黑模式支持
- 微信公众号内容爬取
- 支持外文网站在导出前先翻译为目标语言
- 支持更多自定义导出选项
- 支持更多RSS源格式
WePub 主要解决以下问题：
- 网页内容阅读体验差
- 多页面内容难以整合
- 内容格式难以统一
- 离线阅读需求难以满足
- RSS源内容批量获取与阅读
graph TD
A[网页链接/RSS源输入] --> B[内容抓取模块]
B --> C[内容优化模块]
C --> D[格式转换模块]
D --> E1[HTML]
D --> E2[PDF]
D --> E3[EPUB]
D --> E4[Markdown]
sequenceDiagram
participant U as 用户
participant C as 内容抓取器
participant P as 内容处理器
participant E as 导出转换器
U->>C: 提供网页链接/RSS源
C->>C: 批量抓取内容
C->>P: 原始HTML内容
P->>P: Readability处理
P->>P: 内容清洗
P->>E: 结构化内容
E->>E: 格式转换
E->>U: 返回导出文件
classDiagram
%% 接口定义
class FormatConverter {
<<interface>>
+convert(content, options) Promise<Buffer>
}
class FileSystem {
<<interface>>
+writeFile(path, content) Promise<void>
+readFile(path) Promise<Buffer>
+createTempDir(prefix) Promise<string>
+cleanup(path) Promise<void>
}
%% 核心类
class BaseConverter {
<<abstract>>
#fileSystem: FileSystem
#templateService: TemplateService
+convert(content, options)* Promise<Buffer>
#handleError(error, code, message) never
}
%% 服务类
class FileSystemService {
+writeFile(path, content) Promise<void>
+readFile(path) Promise<Buffer>
+createTempDir(prefix) Promise<string>
+cleanup(path) Promise<void>
}
class TemplateService {
+generateArticleHtml(article, contents, index, timestamp) string
+generateCoverHtml(content) string
+generateTocHtml(content, timestamp) string
+prepareNavigation(contents, currentIndex, timestamp) string
}
class ExportFactory {
-fileSystem: FileSystemService
-templateService: TemplateService
+createConverter(format) FormatConverter
}
%% 转换器实现
class HTMLConverter {
+convert(content, options) Promise<Buffer>
}
class PDFConverter {
+convert(content, options) Promise<Buffer>
}
class EPUBConverter {
+convert(content, options) Promise<Buffer>
}
class MarkdownConverter {
+convert(content, options) Promise<Buffer>
}
%% 错误处理
class ExportError {
+code: ExportErrorCode
+message: string
+details?: unknown
}
%% 关系定义
FormatConverter <|.. BaseConverter
FileSystem <|.. FileSystemService
BaseConverter <|-- HTMLConverter
BaseConverter <|-- PDFConverter
BaseConverter <|-- EPUBConverter
BaseConverter <|-- MarkdownConverter
BaseConverter o-- FileSystem
BaseConverter o-- TemplateService
ExportFactory ..> FormatConverter
ExportFactory o-- FileSystemService
ExportFactory o-- TemplateService
Error <|-- ExportError
- 前端框架：Next.js 15 (App Router)
- 样式方案：Tailwind CSS + shadcn/ui
- 内容处理：Mozilla Readability
- 文档转换：Percollate
- 类型系统：TypeScript
- 部署平台：Vercel
src/
├── app/ # Next.js 应用目录
│ ├── api/ # API 路由
│ │ ├── export/ # 导出相关接口
│ │ │ └── route.ts # 导出处理路由
│ │ ├── crawl/ # 抓取相关接口
│ │ │ └── route.ts # 抓取处理路由
│ │ ├── parse/ # 解析相关接口
│ │ │ └── route.ts # 解析处理路由
│ │ └── rss/ # RSS相关接口
│ │ └── route.ts # RSS处理路由
│ ├── layout.tsx # 应用布局
│ ├── page.tsx # 主页面
│ └── globals.css # 全局样式
├── components/ # React 组件
│ ├── SiteCrawler.tsx # 网站抓取器组件
│ ├── ExportDialog.tsx # 导出对话框组件
│ ├── ArticleConverter.tsx # 文章转换器组件
│ ├── AuthorCard.tsx # 作者卡片组件
│ ├── ThemeProvider.tsx # 主题提供者组件
│ ├── ThemeToggle.tsx # 主题切换组件
│ └── ui/ # UI 基础组件
├── core/ # 核心接口和类型定义
│ ├── errors/ # 错误处理
│ │ └── export.error.ts # 导出相关错误定义
│ └── interfaces/ # 接口定义
│ ├── content.interface.ts # 内容相关接口
│ └── converter.interface.ts # 转换器接口
├── services/ # 服务层
│ ├── converters/ # 格式转换器
│ │ ├── base.converter.ts # 基础转换器
│ │ ├── html.converter.ts # HTML转换器
│ │ ├── pdf.converter.ts # PDF转换器
│ │ ├── epub.converter.ts # EPUB转换器
│ │ └── markdown.converter.ts # Markdown转换器
│ ├── export.factory.ts # 导出工厂
│ ├── file.service.ts # 文件服务
│ └── template.service.ts # 模板服务
├── lib/ # 工具库
│ └── utils.ts # 通用工具函数
├── styles/ # 样式定义
│ └── index.ts # 样式导出
└── middleware.ts # Next.js 中间件
- app/: Next.js 应用主目录，包含页面和API路由
- components/: React 组件库，包含 UI 基础组件和业务组件
- core/: 核心接口和类型定义，确保系统的可扩展性
- services/: 业务服务层，包含各种格式转换器和工具服务
- lib/: 工具库，包含通用工具函数
- styles/: 全局样式定义，包含各种主题和组件样式
-
转换器相关
base.converter.ts: 定义基础转换器抽象类html.converter.ts: HTML格式转换实现pdf.converter.ts: PDF格式转换实现epub.converter.ts: EPUB格式转换实现markdown.converter.ts: Markdown格式转换实现
-
服务类
export.factory.ts: 转换器工厂，负责创建对应格式的转换器file.service.ts: 文件操作服务，处理文件读写template.service.ts: 模板服务，生成各种格式的模板
-
接口定义
content.interface.ts: 内容相关接口定义converter.interface.ts: 转换器接口定义
-
错误处理
export.error.ts: 导出相关错误类型定义
-
组件
SiteCrawler.tsx: 网站抓取器组件，支持批量抓取和RSS源处理ExportDialog.tsx: 导出对话框组件，支持多种格式导出ArticleConverter.tsx: 文章转换器组件，处理单篇文章转换
- Node.js >= 18.0
- npm >= 8.0 或 yarn >= 1.22
- Git >= 2.0
-
安装 Node.js 和 npm
# 检查版本 node -v npm -v -
克隆项目
git clone https://github.com/yourusername/wepub.git cd wepub -
安装依赖
npm install # 或 yarn install -
启动开发服务器
npm run dev # 或 yarn dev -
构建生产版本
npm run build npm start
- 使用 ESLint 进行代码检查
- 使用 Prettier 进行代码格式化
- 遵循 TypeScript 类型检查
如需添加新的导出格式，需要：
- 在
src/core/interfaces/converter.interface.ts中定义接口 - 在
src/services/converters/下创建新的转换器类 - 继承
BaseConverter类并实现convert方法 - 在
ExportFactory中注册新的转换器
示例：
export class NewFormatConverter extends BaseConverter {
async convert(content: Content, options?: ConvertOptions): Promise<Buffer> {
// 实现转换逻辑
}
}- Fork 本项目
- 创建特性分支 (
git checkout -b feature/AmazingFeature) - 提交改动 (
git commit -m 'Add some AmazingFeature') - 推送到分支 (
git push origin feature/AmazingFeature) - 提交 Pull Request
- feat: 新功能
- fix: 修复问题
- docs: 文档修改
- style: 代码格式修改
- refactor: 代码重构
- test: 测试用例修改
- chore: 其他修改
本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情