# simpread

**Repository Path**: north_branch/simpread

## Basic Information

- **Project Name**: simpread
- **Description**: 简悦 ( SimpRead ) - 让你瞬间进入沉浸式阅读的扩展
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-31
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center"><img src="http://sr.ksria.cn/logo%20bigger.png" /></p>
<h1 align="center">简悦 - SimpRead</h1>
<p align="center">让你瞬间进入沉浸式阅读的扩展，还原阅读的本质，提升你的阅读体验。</p>
<p align="center">为了达到完美的阅读模式这个小目标 ，我适配了 <a target="_blank" href="https://simpread.ksria.cn/sites/">数百种类型</a> 的网站，因此诞生了简悦。</p>
<p align="center">
   <a href="https://github.com/kenshin/simpread/releases"><img src="https://img.shields.io/badge/lastest_version-1.1.2-blue.svg"></a>
   <a target="_blank" href="http://ksria.com/simpread"><img src="https://img.shields.io/badge/website-_simpread.ksria.com-1DBA90.svg"></a>
</p>
<p align="center">
   <a target="_blank" href="https://chrome.google.com/webstore/detail/%E7%AE%80%E6%82%A6-simpread/ijllcpnolfcooahcekpamkbidhejabll"><img src="https://img.shields.io/badge/download-_chrome_webstore-brightgreen.svg"></a>
   <a href="http://ksria.com/simpread/crx/1.1.2/simpread.crx"><img src="https://img.shields.io/badge/download-_crx-brightgreen.svg"></a>
   <a target="_blank" href="https://addons.mozilla.org/zh-CN/firefox/addon/simpread"><img src="https://img.shields.io/badge/download-_firefox_addon-DD512A.svg"></a>
   <a target="_blank" href="https://greasyfork.org/zh-CN/scripts/39998"><img src="https://i.imgur.com/JFhxHeR.png"></a>
   <a target="_blank" href="https://xteko.com/redir?url=http://sr.ksria.cn/jsbox/simpread-1.0.2.box?201810231502&name=%E7%AE%80%E6%82%A6"><img src="https://i.imgur.com/zZeOllB.png"></a>
</p>

***

#### 马上使用：
* [Chrome 应用商店](https://chrome.google.com/webstore/detail/%E7%AE%80%E6%82%A6-simpread/ijllcpnolfcooahcekpamkbidhejabll) 或者 [离线下载](http://ksria.com/simpread/crx/1.1.2/simpread.crx)
* [Firefox 扩展中心](https://addons.mozilla.org/zh-CN/firefox/addon/simpread) 
* [支持 UserScript 的浏览器](https://greasyfork.org/zh-CN/scripts/39998) 如：Apple Safari · Microsoft Edge · Opera · Dolphin 详细 [请看这里](https://github.com/Kenshin/simpread-little)
* [iOS（ iPhone / iPad ）版](https://xteko.com/redir?url=http://sr.ksria.cn/jsbox/simpread-1.0.0.box?201805251238&name=%E7%AE%80%E6%82%A6) 详细 [请看这里](http://ksria.com/simpread/docs/#/JSBox)

* 现在就加入 [Telegram 群](https://t.me/simpread)，获取简悦的第一手资料。
* 不同简悦如何使用？想知道简悦的高级功能，请看简悦的 [帮助中心](http://ksria.com/simpread/docs/#) 。

#### 主要功能一览：
- [聚焦模式](http://ksria.com/simpread/docs/#/聚焦模式)：  
  不改变当前页面的结构，仅仅高亮需要阅读的部分，不分散用户的注意力；适合 `临时阅读` 或者 `未适配阅读模式` 的网站

- [阅读模式](http://ksria.com/simpread/docs/#/阅读模式)：  
  简悦 `原创` 功能，逐一适配了 [数百种类型](https://simpread.ksria.cn/sites/) 的网站，自动提取 `标题` `描述` `正文` `媒体资源（ 图片/ 视频 ）` 等，生成 `符合中文阅读` 的页面

  * 支持 `自动生成目录` [TXT 阅读器](http://ksria.com/simpread/docs/#/TXT-阅读器) [论坛类页面及分页](http://ksria.com/simpread/docs/#/论坛类页面及分页) 如：知乎 · 百度贴吧等

  * 更符合 `中文阅读` 习惯的设置，包括：`字间距` `行间距` 等 以及 `自定义 CSS` ，详细请看 [自定义样式](http://ksria.com/simpread/docs/#/自定义样式)

- 临时阅读模式：  
  将 `非适配阅读模式的页面` 生成 `阅读模式` 一样的排版，支持任意页面，详细请看 [临时阅读模式](http://ksria.com/simpread/docs/#/临时阅读模式) 以及 [操作](http://ksria.com/simpread/welcome/version_1.0.5.html#temp-read-mode)

- 主动适配：  
  通过简单的一个步骤，就可以让 `非适配页面` 支持阅读模式，详细请看 [主动适配](http://ksria.com/simpread/docs/#/主动适配阅读模式) 以及 [操作](http://ksria.com/simpread/welcome/version_1.0.5.html#mate-read-mode)

- 智能适配：  
  自动识别出 Wordpress · Hexo · Ghost · Discuz 等博客 / 论坛的页面以及只要是结构良好的页面，（无需适配）自动生成阅读模式，详细请看 [智能适配](http://ksria.com/simpread/docs/#/智能适配模式)

- 站点适配源：  
  包括：`官方（主）适配源` `第三方适配源` `站点集市适配源` `自定义适配源`，详细请看 [站点适配源](http://ksria.com/simpread/docs/#/站点适配源)

- 站点编辑器：  
  页面任意元素，均可隐藏，`可编程，定制化`，详细请看 [站点编辑器](http://ksria.com/simpread/docs/#/站点编辑器)

- 站点管理器：  
  可管理全部的适配站点，详细请看 [站点管理器](http://ksria.com/simpread/docs/#/站点管理器)

- ![new纯色.png](https://i.loli.net/2018/09/05/5b8f718046acb.png) 站点集市：  
  上传并共享自己的适配站点，一键分享临时阅读模式，适配失败的站一键提交，详细请看 [站点集市](https://simpread.ksria.cn/sites)

- ![new纯色.png](https://i.loli.net/2018/09/05/5b8f718046acb.png) 插件系统：  
  现在开始可以使用 JavaScript 编写基于 `简悦` 的插件了，更上线了 [插件中心](https://simpread.ksria.cn/plugins/) ，如何编写插件请看 → [说明文档](http://ksria.com/simpread/docs/#/插件系统)

- 多种主题：  
  `白练、白磁、卯之花色、丁子色、娟鼠、月白、百合、紺鼠、黒鸢` 等

- 丰富的导出功能，包括：

  - 导出 [Markdown](https://github.com/Kenshin/simpread#感谢) · `HTML` · `PNG` · `PDF` · [epub](http://ksria.com/simpread/docs/#/发送到-Epub)

  - 发送阅读模式优化后的页面到 `Kindle`，详细配置 [请看这里](http://ksria.com/simpread/docs/#/发送到-Kindle)

  - 导出到 `Pocket` `Linnk` `Instapaper` 的功能，包括：`当前页面的链接` `稍后读`

  - 导出到生产力工具，包括：`Dropbox` `Onenote` `Google Drive` `印象笔记 / Evernote`，详细请看 [授权服务](http://ksria.com/simpread/docs/#/授权服务)

- 同步 · 上传/下载 配置 · 同步适配列表 · [快捷键支持](http://ksria.com/simpread/docs/#/快捷键) 等；

- 高级定制，包括：`右键菜单` `控制栏可隐藏` `阅读进度可隐藏` `自动进入阅读模式` [白名单](http://ksria.com/simpread/docs/#/FAQ?id=白名单) 以及 [排除列表](http://ksria.com/simpread/docs/#/FAQ?id=排除列表) 等

- 稍后读；

#### 截图：
![简单阅读，愉悦心情！](http://sr.ksria.cn/welcome-readme-1.png)
![多种导出方式](http://sr.ksria.cn/welcome-readme-3.png)  
![定制化，可编程](http://sr.ksria.cn/welcome-readme-4.png)  

#### 照片集：
> 包含了 `稍后读` `阅读模式 · 设置界面` `导出到生产力工具` `发送到 Kindle` `自定义样式` `同步配置` `论坛类页面 · 分页` 等功能的截图（动图）

* <http://ksria.com/simpread/gallery/>

#### 全部功能：
![功能一览](http://sr.ksria.cn/feature%201.1.2.png)

#### 如何使用（阅读模式）：

`简悦`会自动检测当前页面是否已经适配，如适配则在浏览器右上角显示 ![Imgur](http://i.imgur.com/dyROEBi.png) ，使用以下三种方式启动：

- 点击浏览器右上角 `红色icon`；

- 右键选择 `简悦 - SimpRead` → `阅读模式`；

- 快捷键；（默认为 双击 <kbd>A</kbd> )


#### 如何使用（聚焦模式）：
`聚焦模式` 会自动获取当前鼠标所在的段落并高亮，适合任意页面。

- 在需要高亮的区域，右键选择 `简悦 - SimpRead` → `聚焦模式`；

- 快捷键；（默认为 <kbd>A</kbd> <kbd>S</kbd> )

#### 提交新站：

* 方式1：通过 **提交到 站点集市** 的方式，详细请看 [站点管理器 · 上传](http://ksria.com/simpread/docs/#/站点管理器?id=上传)

* 方式2：通过 **提交 issues** 的方式（不要使用 `pr` 方式），请提交网址 [到这里](https://github.com/kenshin/simpread/labels/new%20site)；  
  > 当适配完成后关闭此 `issues`，之后通过 `简悦` → `选项` → `手动同步适配列表` 更新；

* 方式3：通过 **新增站点编辑器** 的方式（适合逐一添加单个新站），详细说明 [请看这里](http://ksria.com/simpread/docs/#/站点编辑器?id=如何新增修改)；

* 方式4：通过 **提交适配源** 的方式（适合同时添加多个新站），详细说明请看 [使用自定义适配源](http://ksria.com/simpread/docs/#/站点适配源?id=如何提交到简悦的官方（次）适配源)

* 更多说明请看 [站点编辑器](http://ksria.com/simpread/docs/#/站点编辑器) [站点管理](http://ksria.com/simpread/docs/#/站点管理器) [站点适配源](http://ksria.com/simpread/docs/#/站点适配源)；

#### Chrome / Firefox / 轻阅版（UserScript）功能差别：
![Chrome / Firefox / 轻阅版（UserScript）功能差别](https://i.imgur.com/z4WI7uK.png)

#### 投票：
简悦是一个免费并开源的项目。如果觉得不错，请给我 [投票](https://chrome.google.com/webstore/detail/%E7%AE%80%E6%82%A6-simpread/ijllcpnolfcooahcekpamkbidhejabll/reviews) 。这样让更多人了解并受用与 `简悦` 带来的便利，你的认可是对我最大的鼓励。

#### 相关链接：
* [更新日志](http://ksria.com/simpread/changelog.html)
* [帮助中心](http://ksria.com/simpread/docs/#)
* [新手入门](http://ksria.com/simpread/docs/#/入门指南（-操作指引-）)
* [常见问题](http://ksria.com/simpread/docs/#/FAQ)
* [反馈](https://github.com/kenshin/simpread/issues)
* [联系](http://kenshin.wang) · [邮件](kenshin@ksria.com) · [微博](http://weibo.com/23784148) · [Telegram 群](https://t.me/simpread)
* 想了解简悦背后的故事？ [猛击这里](https://sspai.com/post/39491)

#### 感谢：
- [ksky521](https://github.com/ksky521) 提供 `minimatch` 和 `markdown转换功能` ，解决了 [Fix 11](https://github.com/kenshin/simpread/issues/11)，详细请看 Pull requests [#16](https://github.com/kenshin/simpread/pull/16)；
- [airycanon](https://github.com/airycanon) Pull requests 详细请看 [#23](https://github.com/kenshin/simpread/pull/23) [#44](https://github.com/kenshin/simpread/pull/44) [#124](https://github.com/kenshin/simpread/pull/124)；
- [mikelei8291](https://github.com/mikelei8291) 详细请看 Pull requests [#114](https://github.com/kenshin/simpread/pull/114)；

#### 简悦的诞生离不开它们：
- [Node.js](https://nodejs.org/) · [NPM](https://www.npmjs.com)
- [Webpack](https://webpack.github.io/)
- [React](https://facebook.github.io/react)
- [ES6](http://es6-features.org/) · [Babel](https://babeljs.io)
- [PostCSS](http://postcss.org/) · [cssnext](http://cssnext.io/)
- [jQuery](https://jquery.com/) · [Mousetrap](https://craig.is/killing/mice) · [pangu.js](https://github.com/vinta/pangu.js) · [ProgressBar.js](https://kimmobrunfeldt.github.io/progressbar.js/) · [timego.js](http://timeago.org/) · [Velocity.js](http://velocityjs.org/) · [minimatch](https://github.com/isaacs/minimatch) · [to-markdown](https://github.com/domchristie/to-markdown) · [FileSaver.js](https://github.com/eligrey/FileSaver.js) · [dom-to-image](https://github.com/tsayen/dom-to-image)
- [Visual Studio Code](https://code.visualstudio.com/)
- [Sketch](https://www.sketchapp.com/) · [Pixelmator](http://www.pixelmator.com/)
- Icon from <http://iconfont.cn>
- Mockup Design usage <http://magicmockups.com/>
- Material Design usage <https://material.io/guidelines/>
- Mind Maps <https://coggle.it/>
- 咖啡 · 网易音乐 · Google Chrome · rMBP

#### 协作开发：
- Pull requests 方式：
  * 请从 `develop` 分支开始；（ 注意：非 develop 分支的 pr 将不会合并；）
  * Pull requests
  * 如果需要合并的话，合并后我会通知你；（在下个版本发布时一起发布）

- 源代码编译：
  * git clone https://github.com/Kenshin/simpread.git
  * cd simpread
  * npm install
  * npm run develop ( for Mac ) 用于开发
  * npm run publish ( for Mac ) 用于发布
  * npmw run develop ( for Win ) 用于开发
  * npmw run publish ( for Win ) 用于发布

#### 请杯咖啡：
如果简悦可以解决你在阅读上痛点，提升 Web 端的阅读体验，可以请我喝杯咖啡，想必也是非常愉悦的事情。 :smile:  
_如发现下图显示不全，请直接访问 http://sr.ksria.cn/zhifu_m2.png_  
![支付](http://sr.ksria.cn/zhifu_m2.png)

#### 许可：
[![license-badge]][license-link]

<!-- Link -->
[www-badge]:        https://img.shields.io/badge/website-_simpread.ksria.com-1DBA90.svg
[www-link]:         http://ksria.com/simpread
[version-badge]:    https://img.shields.io/badge/lastest_version-1.1.2-blue.svg
[version-link]:     https://github.com/kenshin/simpread/releases
[chrome-badge]:     https://img.shields.io/badge/download-_chrome_webstore-brightgreen.svg
[chrome-link]:      https://chrome.google.com/webstore/detail/%E7%AE%80%E6%82%A6-simpread/ijllcpnolfcooahcekpamkbidhejabll
[offline-badge]:    https://img.shields.io/badge/download-_crx-brightgreen.svg
[offline-link]:     http://ksria.com/simpread/crx/1.1.2/simpread.crx
[license-badge]:    https://img.shields.io/github/license/mashape/apistatus.svg
[license-link]:     https://opensource.org/licenses/MIT