https://github.com/snowdreams1006/gitbook-plugin-readmore
Gitbook 整合 OpenWrite 平台的 readmore 插件,实现博客的每一篇文章自动增加阅读更多效果,关注公众号后方可解锁全站文章,从而实现博客流量导流到微信公众号粉丝目的.
https://github.com/snowdreams1006/gitbook-plugin-readmore
gitbook-plugin-openwrite gitbook-plugin-readmore openwrite readmore wechat
Last synced: about 1 year ago
JSON representation
Gitbook 整合 OpenWrite 平台的 readmore 插件,实现博客的每一篇文章自动增加阅读更多效果,关注公众号后方可解锁全站文章,从而实现博客流量导流到微信公众号粉丝目的.
- Host: GitHub
- URL: https://github.com/snowdreams1006/gitbook-plugin-readmore
- Owner: snowdreams1006
- License: mit
- Created: 2019-10-07T02:15:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-11T01:12:47.000Z (over 6 years ago)
- Last Synced: 2024-04-24T13:10:52.018Z (about 2 years ago)
- Topics: gitbook-plugin-openwrite, gitbook-plugin-readmore, openwrite, readmore, wechat
- Language: JavaScript
- Homepage: https://snowdreams1006.github.io/gitbook-plugin-readmore/
- Size: 1020 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 欢迎访问 [gitbook-plugin-readmore](https://snowdreams1006.github.io/gitbook-plugin-readmore/) 官网 👋
[](https://www.npmjs.com/package/gitbook-plugin-readmore)
[](https://www.npmjs.com/package/gitbook-plugin-readmore)
[](https://www.npmjs.com/package/gitbook-plugin-readmore)
[](https://github.com/snowdreams1006/gitbook-plugin-readmore/blob/master/LICENSE)
[](https://github.com/snowdreams1006)
[](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)
> Gitbook 整合 OpenWrite 平台的 readmore 插件,实现博客的每一篇文章自动增加阅读更多效果,关注公众号后方可解锁全站文章,从而实现博客流量导流到微信公众号粉丝目的.
## 效果
## 用法
### Step #1 - 更新 `book.json` 配置文件
1. 在 `book.json` 配置文件中,添加 `readmore` 到 `plugins` 列表.
2. 在 `book.json` 配置文件中,配置 `pluginsConfig` 对象.
```json
{
"plugins": ["readmore"],
"pluginsConfig": {
"readmore":{
"blogId": "15702-1569305559839-744",
"name": "雪之梦技术驿站",
"qrcode": "https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg",
"keyword": "vip"
}
}
}
```
其中,配置参数含义如下:
- `blogId` : [必选]OpenWrite 后台申请的博客唯一标识,例如:15702-1569305559839-744
- `name` : [必选]OpenWrite 后台申请的博客名称,例如:雪之梦技术驿站
- `qrcode` : [必选]OpenWrite 后台申请的微信公众号二维码,例如:https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg
- `keyword` : [必选]OpenWrite 后台申请的微信公众号后台回复关键字,例如:vip
### Step #2 - 运行 gitbook 相关命令
- 运行 `gitbook install` 命令安装到本地项目
```bash
# 方式一: gitbook安装插件
$ gitbook install
# 方式二: npm直接安装
$ npm i gitbook-plugin-readmore
```
- 运行 `gitbook build` 命令构建本地项目或者 `gitbook serve` 启动本地服务.
```bash
$ gitbook build
```
或者
```bash
$ gitbook serve
```
## 作者
👤 **snowdreams1006**
- Github: [@snowdreams1006](https://github.com/snowdreams1006)
- Email: [snowdreams1006@163.com](mailto:snowdreams1006@163.com)
## 🤝 贡献
如果你想贡献自己的一份力量,欢迎提交 [`Issues`](https://github.com/snowdreams1006/gitbook-plugin-readmore/issues) 或者 `Pull Request` 请求!
## 支持
如果本项目对你有所帮助,欢迎 ⭐️ [gitbook-plugin-readmore](https://github.com/snowdreams1006/gitbook-plugin-readmore) 项目,感谢你的支持与认可!
## 📝 版权
Copyright © 2019 [snowdreams1006](https://github.com/snowdreams1006).
This project is [MIT](https://github.com/snowdreams1006/gitbook-plugin-readmore/blob/master/LICENSE) licensed.