ReadCat开源小说阅读器使用指南

ReadCat是一款免费、开源、简洁、纯净、无广告的小说阅读器，基于Vue3和Electron技术构建，支持Windows、macOS和Linux等多平台运行。

核心功能特性

ReadCat提供了丰富的阅读功能，包括：

• 插件系统支持书源扩展和朗读功能
• 智能搜索和书架管理
• 书签管理和阅读进度同步
• 深色模式和自定义主题
• 跨平台兼容性

ReadCat优雅的界面设计

技术架构

项目采用现代化的前端技术栈：

• 前端框架：Vue 3 + TypeScript
• 桌面端：Electron跨平台方案
• 构建工具：Vite极速构建
• 状态管理：Pinia轻量级方案
• UI组件：Element Plus设计系统

安装与部署

环境要求

• Node.js运行环境
• npm或yarn包管理器

快速开始

1. 克隆项目代码：

git clone https://gitcode.com/gh_mirrors/re/read-cat

2. 安装项目依赖：

npm install

3. 开发模式运行：

npm run dev

4. 构建生产版本：

npm run build

项目结构解析

read-cat/
├── electron/          # Electron主进程代码
│   ├── main.ts       # 主进程入口
│   ├── preload.ts    # 预加载脚本
│   └── shortcut-key.ts # 快捷键管理
├── src/              # 渲染进程源码
│   ├── core/         # 核心功能模块
│   │   ├── plugins/  # 插件系统
│   │   ├── database/ # 数据存储
│   │   └── request/  # 网络请求
│   ├── views/        # 页面视图组件
│   │   ├── bookshelf/ # 书架页面
│   │   ├── read/     # 阅读页面
│   │   └── search/   # 搜索页面
│   ├── components/   # 通用UI组件
│   ├── assets/       # 静态资源文件
│   └── store/        # 状态管理
├── public/           # 公共资源目录
└── scripts/          # 构建脚本

ReadCat的明亮主题样式

插件系统

ReadCat拥有强大的插件生态系统，支持：

• 书源插件：扩展小说内容来源
• 朗读插件：文本转语音功能
• 自定义插件：开发者可自行扩展功能

插件开发文档位于：src/core/plugins/

阅读体验优化

主题定制

通过修改主题配置文件，用户可以自定义：

• 颜色方案和字体设置
• 阅读界面布局
• 背景图片和透明度

ReadCat的深色主题效果

快捷键设置

支持自定义快捷键操作，提升阅读效率：

• 翻页控制
• 字体大小调整
• 书签管理
• 模式切换

数据管理

本地存储

使用IndexedDB进行数据持久化：

• 书架信息存储
• 阅读进度记录
• 书签数据保存
• 用户设置配置

数据同步

支持阅读进度和书签的跨设备同步功能

开发贡献

欢迎开发者参与项目贡献，主要开发领域包括：

• 插件开发与扩展
• UI界面优化
• 性能调优
• 新功能开发

贡献指南请参考项目文档中的开发规范部分。

常见问题解答

插件导入

首次使用需要导入书源插件才能获取在线小说内容。插件导入方法请参考相关文档。

平台兼容性

ReadCat支持主流操作系统，包括Windows 10/11、macOS 10.14+、Ubuntu 16.04+等。

性能优化

针对大量书籍的管理和搜索进行了性能优化，确保流畅的用户体验。

技术支持

如遇到使用问题或需要技术支持，可以通过以下方式获取帮助：

• 查阅项目文档
• 查看常见问题解答
• 提交Issue反馈问题

ReadCat致力于为用户提供纯净、无广告的阅读体验，持续优化产品功能和使用体验。