Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/easychen/h2webreader
h2book web reader
https://github.com/easychen/h2webreader
Last synced: about 2 months ago
JSON representation
h2book web reader
- Host: GitHub
- URL: https://github.com/easychen/h2webreader
- Owner: easychen
- Created: 2017-08-16T09:58:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T17:28:13.000Z (8 months ago)
- Last Synced: 2024-06-21T23:37:50.922Z (3 months ago)
- Language: JavaScript
- Size: 1.7 MB
- Stars: 78
- Watchers: 5
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 方糖氢小说阅读器
⚠️ 已经更新为V2，内置了头像和小说元信息，不再兼容之前的格式，
- [V1版本见这里](https://github.com/easychen/h2webreader/tree/v1)
- 支持 PHP 上传的版本 https://github.com/easychen/h2reader-host
---
氢小说(H2 Book)是一种对话体、类剧本式的图书格式。它采用对话和场景来展现故事、描述事实，又非常接近于我们平时使用的聊天软件，所以读起来更为轻松。
[点这里感受下](http://du.ftqq.com) && [使用帮助](http://du.ftqq.com/read/1)
访问 [qing.ftqq.com](https://qing.ftqq.com) 可以在线编辑 H2 Book的内容。通过右下角最末的导出按钮，可以下载为 h2book 格式的文件。方糖氢小说阅读器（即本项目）则负责读取 h2book 并提供阅读界面。
### 使用方法
#### 创作内容
- 到 [qing.ftqq.com](https://qing.ftqq.com) 编写书籍内容。
- 右下角最末的导出按钮，获得 `*.h2book` 文件。
#### 制作阅读器
```
git clone https://github.com/easychen/h2webreader
cd h2webreader
yarn
```
然后将之前下载 `*.h2book` 文件改名为 `2.h2zip` 放入 `public/books` 目录下。
```
yarn start
```
打开浏览器访问 `http://localhost:3000/2` 就可以阅读了。注意目录名称要和 `.h2book` 文件名一致（不包括后缀）。这时候可以修改 `index.scss` 来定制阅读界面的样式。
#### 文章列表
修改 books/index.json 可以修改首页显示的文章列表。
#### 发布阅读器
定制完成后，运行
```
yarn build
```
会在根下生成一个 `build` 目录，将目录下所有内容放到一个服务器的 web 目录下就OK了。注意本项目只附带了 apache 的 rewrite 文件，其他服务器需自己添加。
Nginx 参考：
https://stackoverflow.com/questions/36304302/how-can-i-configure-react-router-to-with-nginx-cherrypy-and-my-current-reactjs-a
```
location / {
root /var/www;
index index.html;
try_files $uri $uri/ /index.html;
}
```
#### 追加图书
新写了图书，只要将 `.h2book` 文件放到服务器 web 目录下的 `books` 之下，就可以通过 url （ http://domian/bookname ） 进行访问了。
### License
MIT