1.0.0 • Published 4 months ago
console-epub-reader v1.0.0
控制台EPUB阅读器
这是一个基于Node.js开发的简单控制台EPUB电子书阅读器,允许用户在终端中阅读EPUB格式的电子书。
功能特点
- 解析EPUB格式电子书
- 在控制台中清晰显示内容
- 使用键盘上下箭头进行导航
- 自动保存阅读进度
- 显示当前阅读进度百分比
安装方法
- 确保已安装Node.js环境(建议v14.0.0或更高版本)
- 克隆或下载本项目
- 在项目根目录执行以下命令安装依赖:
npm install
作为npm包安装
npm install -g console-epub-reader
使用方法
- 在项目的
epub
目录下放置名为index.epub
的EPUB文件 - 在项目根目录执行以下命令启动阅读器:
npm start
- 操作说明:
- 上箭头键:上一页
- 下箭头键:下一页
- 按Q键:退出阅读器
项目结构
node-r/
├── epub/ # 存放EPUB文件的目录
│ └── index.epub # 要阅读的EPUB文件(需自行放置)
├── src/ # 源代码目录
│ ├── index.js # 程序入口文件
│ ├── parser.js # EPUB解析器
│ └── reader.js # 阅读器界面实现
├── .reading-progress # 阅读进度保存文件
├── package.json # 项目配置和依赖
└── README.md # 项目说明文档
核心文件说明
- index.js: 程序入口,负责初始化解析器和阅读器
- parser.js: 实现EPUB文件的解析,提取文本内容
- reader.js: 实现控制台界面显示和键盘交互
技术依赖
- epub: EPUB文件解析库
- chalk: 控制台文字颜色和样式美化
如何扩展
如果您想读取其他EPUB文件,只需将文件放入epub
目录并命名为index.epub
,或修改index.js
中的文件路径配置。
注意事项
- 程序默认读取项目根目录下
epub/index.epub
文件 - 阅读进度会自动保存在项目根目录的
.reading-progress
文件中 - 目前仅支持纯文本内容的显示,不支持图片等多媒体内容
1.0.0
4 months ago