介绍
gitbook-plugin-edit-link 是一个 GitBook 插件，它可以在每个页面的底部添加一个编辑页面链接，方便读者直接跳转到 GitHub 等代码仓库中修改该页面的源代码。该插件适用于需要多人协作编写文档的项目。
本文将详细介绍如何使用 gitbook-plugin-edit-link 插件。
安装
使用 npm 进行安装：
npm install gitbook-plugin-edit-link --save-dev
安装完成后，在 book.json 文件中添加以下内容：
{ "plugins": ["edit-link"] }
配置
插件支持以下配置项：
base: 仓库的基本 URL。label: 编辑页面链接的标签名。title: 编辑页面链接的 title 属性。
在 book.json 文件中添加配置项：
-- -------------------- ---- ------- - ---------------- - ------------ - ------- --- -------- ----- ---- ------ -------- ----- ---- ---- -- ------- - - -展开代码
示例
假设我们要为一个开源项目编写文档，并将其托管在 GitHub 上。我们首先创建一个名为 my-project 的 Git 仓库，并将其克隆到本地：
git clone https://github.com/my-username/my-project.git cd my-project
然后我们在项目根目录下创建一个 docs 目录，并在其中初始化一个 GitBook 项目：
npm install gitbook-cli -g gitbook init docs
我们进入 docs 目录并安装 gitbook-plugin-edit-link 插件：
cd docs npm install gitbook-plugin-edit-link --save-dev
接下来，我们在 book.json 文件中添加插件配置项：
-- -------------------- ---- ------- - ---------------- - ------------ - ------- ----------------------------------------------------------- -------- ----- ---- ------ -------- ----- ---- ---- -- ------- - - -展开代码
最后，我们在 GitBook 中编写文档，并构建：
gitbook serve现在，每个页面的底部都会有一个编辑页面链接，点击该链接将跳转到对应的源代码页面。
总结
gitbook-plugin-edit-link 是一个方便的 GitBook 插件，它可以为多人协作编写文档的项目提供便利。在本文中，我们介绍了该插件的安装、配置和使用方法，并提供了示例代码。希望本文能够对您的工作有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/52262
