https://github.com/gxr404/comic-book-browser
漫画浏览器
https://github.com/gxr404/comic-book-browser
cli comic comic-book comic-reader manga manga-reader
Last synced: 10 months ago
JSON representation
漫画浏览器
- Host: GitHub
- URL: https://github.com/gxr404/comic-book-browser
- Owner: gxr404
- License: agpl-3.0
- Created: 2024-01-05T17:17:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T05:23:12.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T12:24:36.071Z (over 1 year ago)
- Topics: cli, comic, comic-book, comic-reader, manga, manga-reader
- Language: TypeScript
- Homepage:
- Size: 2.3 MB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Comic Book Browser
一款漫画浏览器(搭配comic-book-dl使用)
开源 | 高效 | 易用
## 动机
平常喜欢看漫画的人肯定有体验过在网页看漫画，看着看着就突然弹出各种跳花里胡哨的小广告, 不小心点到还跳转到广告网站，体验非常差。
因此我就想开发一套离线本地存储的漫画书架，可以轻松管理平时关注的漫画，且无广告界面简洁，一些经典完结的漫画也可以当收藏存到自己的硬盘里，由此诞生了该项目🤔。
## 安装
```bash
npm i -g comic-book-browser
```
## 用法
```bash
$ comic-book-browser --help
Usage:
$ comic-book-browser [options]
Options:
-d, --bookPath 漫画目录(comic-book所在的目录) eg: -d . (default: .)
-p, --port 服务启动的端口号 eg: -p 3000 (default: 3000)
-h, --help Display this message
-v, --version Display version number
```
## Start
使用 [comic-book-dl](https://github.com/gxr404/comic-book-dl) 下载完漫画后在当前含有`comic-book`目录
执行:
```bash
# 当前目录需含有 comic-book文件夹
$ comic-book-browser
> comic-book-browser [INFO]: \(^o^)/ 服务已启动 请用浏览器打开 http://127.0.0.1:3000
```
> PS: 当然也可以不使用`comic-book-dl` 只要当前目录符合结构即可正常启动，注意的是 `bookInfo.json`里的字段得有且符合对应结构
```bash
.
└── comic-book
├── <漫画名>
│ ├── bookInfo.json
│ ├── cover.jpg
│ └── chapters
│ ├── 第01话
│ │ └── xxx.jpg
│ ....
```
## 常见问题
- 新增漫画时如果刷新没显示新漫画?
- 可点击右下角清理缓存，或者重新启动`comic-book-browser`服务即可
## 界面
`comic-book-browser`提供了两套主题、适配移动端、界面简洁
## 功能与建议
目前项目处于开发初期, 如果你对该项目有任何功能与建议，欢迎在 Issues 中提出