欢迎访问 gitbook-plugin-edit-link-plus 官网👋
添加 “编辑此页” 链接并智能识别
Github或Gitlab源存储库的Gitbook插件.
🏠 主页
- 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/
屏幕截图
用法
步骤＃1-更新book.json文件
- 在您的gitbook的
book.json文件中，将edit-link-plus到plugins列表。 - 在
pluginsConfig，设置base值，该base值是github或gitlab或其他代码存储库的基本路径。不需要尾部斜杠。 - 默认情况下，链接标签为“编辑此页”。您可以使用插件配置
label进行更改。 - 在
pluginsConfig，设置defaultBase值，该值设置为github或gitlab或其他代码存储库的默认基本路径。也不需要尾部斜杠。
这是最简单的示例：
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book"
}
}
}
此外，受支持的配置选项如下：
"base": {
"type": [
"string",
"object"
],
"title": "Base for the edit redirection",
"required": true
},
"defaultBase": {
"type": "string",
"title": "Default base for the edit redirection",
"required": false
},
"label": {
"type": [
"string",
"object"
],
"title": "Label for the edit button",
"default": "Edit This Page",
"required": false
}
步骤＃2-gitbook命令
- 运行
gitbook install。它将自动为您的书安装edit-link-plusgitbook插件。仅需要一次。
gitbook install
或者，您可以运行npm install gitbook-plugin-edit-link-plus进行本地安装。
npm install gitbook-plugin-edit-link-plus
- 像往常一样构建您的书（
gitbook build）或服务（gitbook serve）。
gitbook serve
示例
- 官方文档配置文件
https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/blob/master/docs/book.json
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": {
"snowdreams1006.github.io":"https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/docs",
"snowdreams1006.gitlab.io":"https://gitlab.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/docs",
"snowdreams1006.gitee.io":"https://gitee.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/docs"
},
"defaultBase": "https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/docs",
"label": "Edit This Page"
}
}
}
- 官方示例配置文件
https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/blob/master/example/book.json
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": "https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/example"
}
}
}
示例book.json文件
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": "https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/example"
}
}
}
或者您可以添加label以自定义标签：
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book",
"label": "点我反馈"
}
}
}
用于多源基础的样本book.json文件
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": {
"USER.github.io":"https://github.com/USER/REPO/edit/BRANCH/path/to/book",
"USER.gitlab.io":"https://gitlab.com/USER/REPO/edit/BRANCH/path/to/book",
"USER.gitee.io":"https://gitee.com/USER/REPO/edit/BRANCH/path/to/book",
"CUSTOME DOMAIN":"https://github.com/snowdreams1006/gitbook-plugin-edit-link-plus/edit/master/docs"
},
"defaultBase": "https://github.com/USER/REPO/edit/BRANCH/path/to/book",
"label": "Edit This Page"
}
}
}
用于多语言标签的样例book.json文件
{
"plugins": ["edit-link-plus"],
"pluginsConfig": {
"edit-link-plus": {
"base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book",
"label": {
"en": "Edit This Page",
"zh": "编辑本页"
}
}
}
}
注意 ：如果您的书还没有，以上代码段可以用作完整的book.json文件。
Github / Gitlab ：在字符串...REPO/edit/BRANCH... ，如果希望源文件以读取模式打开，而不是直接在github / gitlab上以编辑模式打开，则可以用tree替换edit 。
作者
👤 snowdreams1006
贡献
欢迎提供文稿，问题和功能请求！
随时检查问题页面 。
表示支持
如果这个项目对您有帮助，请给个星星 ！
版权
版权所有©2019 snowdreams1006 。
该项目是MIT许可的。
感谢
故障排除
- 如果没有看到“编辑此页面”链接，请检查
book.json是否有效。您可以使用此在线工具-http://json.parser.online.fr/beta/ - 检查您是否使用默认的gitbook主题。不建议直接修改gitbook主题。
作者: 雪之梦技术驿站
链接: https://snowdreams1006.github.io/gitbook-plugin-edit-link-plus/zh/
来源: 雪之梦技术驿站
本文原创发布于「雪之梦技术驿站」,转载请注明出处,谢谢合作!
