Need private packages and team management tools?Check out npm Teams »

gitbook-plugin-readmore

1.1.1 • Public • Published

欢迎访问 gitbook-plugin-readmore 官网 👋

npm:version npm:download npm:prerequisite github:documentation github:maintenance npm:license github:snodreams1006 微信公众号:雪之梦技术驿站-brightgreen.svg

Gitbook 整合 OpenWrite 平台的 readmore 插件,实现博客的每一篇文章自动增加阅读更多效果,关注公众号后方可解锁全站文章,从而实现博客流量导流到微信公众号粉丝目的.

🏠 主页

效果

readmore-use-preview.png

用法

Step #1 - 更新 book.json 配置文件

  1. book.json 配置文件中,添加 readmoreplugins 列表.
  2. book.json 配置文件中,配置 pluginsConfig 对象.
{
    "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 命令安装到本地项目
$ gitbook install
  • 运行 gitbook build 命令构建本地项目或者 gitbook serve 启动本地服务.
$ gitbook build

或者

$ gitbook serve

示例

不仅 gitbook-plugin-readmore 官方文档已整合 readmore 版权保护插件,此外还提供了示例项目,详情参考 example 目录.

作者

👤 snowdreams1006

🤝 贡献

如果你想贡献自己的一份力量,欢迎提交 Issues 或者 Pull Request 请求!

支持

如果本项目对你有所帮助,欢迎 ⭐️ gitbook-plugin-readmore 项目,感谢你的支持与认可!

📝 版权

Copyright © 2019 snowdreams1006.

This project is MIT licensed.

Install

npm i gitbook-plugin-readmore

DownloadsWeekly Downloads

5

Version

1.1.1

License

MIT

Unpacked Size

323 kB

Total Files

7

Last publish

Collaborators

  • avatar