Gitbook plugin add "edit this page" link, and intelligent recognition to Github or Gitlab source repository.

Homepage

• Github : https://snowdreams1006.github.io/gitbook-plugin-edit-link-plus/
• GitLab: https://snowdreams1006.gitlab.io/gitbook-plugin-edit-link-plus/
• Gitee : https://snowdreams1006.gitee.io/gitbook-plugin-edit-link-plus/

Screenshot

Usage

1 - Update book.json file

1. In you gitbook's book.json file, add edit-link-plus to plugins list.
2. In pluginsConfig, Set base value which is base path to your github or gitlab or other code repo. Trailing slash is NOT required.
3. By default link label will be "Edit This Page". You can change it using plugin config label.
4. In pluginsConfig, Set defaultBase value which is set as default base path to your github or gitlab or other code repo. Trailing slash is also NOT required.

Here is simplest example :

In addition, the supported configuration options are as follows :

2 - gitbook commands

1. Run gitbook install. It will automatically install edit-link-plus gitbook plugin for your book. This is needed only once.

gitbook install

or you can run npm install gitbook-plugin-edit-link-plus to install locally.

npm install gitbook-plugin-edit-link-plus

1. Build your book (gitbook build) or serve (gitbook serve) as usual.

gitbook serve

Example

• Official documentation configuration file

https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/blob/master/docs/book.json

• Official example configuration file

https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/blob/master/example/book.json

Sample book.json file

or you can add label to custom your label:

Sample book.json file for Multi-source base

Sample book.json file for multilingual labels

Note: Above snippet can be used as complete book.json file, if your book doesn't have one yet.

Github/Gitlab: In string ...REPO/edit/BRANCH..., you may replace edit with tree if you want source file to open in read-mode, rather than edit-mode directly on github/gitlab.

Author

snowdreams1006

• Website: https://snowdreams1006.tech/
• Github: https://github.com/snowdreams1006
• Email: mailto:snowdreams1006@163.com

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/issues.

Show your support

Give a https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus if this project helped you!

Copyright

Copyright © 2019 https://github.com/snowdreams1006.

This project is https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/blob/master/LICENSE licensed.

Thanks

• https://github.com/zhaoda/gitbook-plugin-editlink
• https://github.com/rtCamp/gitbook-plugin-edit-link

Troubleshooting

1. If you are not seeing the "Edit this page" link, check if your book.json is valid. You can use this online tool - http://json.parser.online.fr/beta/
2. Check if you are using default gitbook theme. It is NOT recommended to modify gitbook themes directly.

如果你觉得本文对你有所帮助,欢迎点赞评论和转发,来一波素质三连吧! 偷偷告诉你,点击了解更多可以获得最佳阅读体验哟!

本文标签：word无法启动转换器mswrd632(15)