npm包 gitbook-plugin-link-fix 使用教程

在前端开发中,我们常常需要使用到文档的引用,而gitbook就是一个非常强大的开源文档管理工具。然而在使用gitbook过程中,我们可能会发现当跳转到内部文档链接时,如果当前的页面路径变更,链接不会跟随变化,这时候就需要使用一个npm包,即gitbook-plugin-link-fix。

1. 安装npm包

可以在命令行中输入以下命令进行安装:

--- ------- ----------------------- ----------

由于gitbook-plugin-link-fix是一个本地开发使用的工具,因此我们需要在项目的本地依赖中安装。

2. 配置package.json文件

在项目中,我们需要添加gitbook-plugin-link-fix到package.json中的plugins字段中:

-
  ---------- -
    ----------
  -
-

这样我们就完成了npm包的安装和配置。

3. 使用gitbook-plugin-link-fix

在我们的gitbook项目中,如果需要修复内部链接跳转的问题,只需要在文档中添加一个相关的标记即可。例如:

----------------------------------------

这样我们就可以让这个链接跟随当前页面的路径变化进行相应的调整。

示例代码

假设我们有以下目录结构:

-
--- ---------
--- ---------
--- ----
-   --- ----------
-   --- -----------
-   --- -----------
-   --- -------------
-   --- -------------
--- ------------
    --- -----------------------
    --- ---

在我们的book.json文件中,我们添加:

-
    ---------- -
        ----------
    -
-

在docs/summary.md文件中,我们定义目录结构:

- -------

- -------- ---------------
- -------- ---------------
    - -------- -------------------
    - -------- -------------------

在docs/chapter2-2.md文件中,我们可以添加相应的链接:

----------- --------------------------------

这样我们就可以解决在GitBook中链接跳转的问题。

总结

使用gitbook-plugin-link-fix可以让我们更方便地跳转内部链接,在多个页面之间进行切换,在使用GitBook管理大量文档时非常实用。希望这篇文章能够对大家在前端开发中使用GitBook有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600671d530d0927023822b09


猜你喜欢

  • npm 包 pl-laydate 使用教程

    前言 作为前端开发人员,我们常常需要使用到日期选择器的控件。有很多成熟的日期选择器,但我们通常在其中寻求一个既美观又易于使用的控件。本文将会介绍一个可以满足这些需求的 npm 包——pl-laydat...

    4 年前
  • npm 包 @kryshac/ng-forms 使用教程

    在前端开发中,表单是不可或缺的一部分。但是,表单处理本身可能会变得很复杂。幸运的是,有许多优秀的库可以帮助前端开发人员简化表单处理。其中,一个非常优秀的 npm 包是 @kryshac/ng-form...

    4 年前
  • npm 包 vue-table-row-edit 使用教程

    在前端开发中,表格是一个非常常见且重要的 UI 组件。而在表格中,表格行的编辑操作同样也是非常常见的场景。 vue-table-row-edit 是一个基于 Vue.js 的 npm 包,其实现了表格...

    4 年前
  • npm 包 mpvue-router-patch 使用指南

    前言 在前端开发中,通常使用框架来构建应用程序。Vue.js 是一个流行的前端框架之一,而 mpvue 是一个基于 Vue.js 的小程序开发框架。使用 mpvue 可以快速地构建出高质量的小程序。

    4 年前
  • npm包@bzxnetwork/bzx.js使用教程

    简介 @bzxnetwork/bzx.js是基于Web3的去中心化借贷协议bZx Network的JavaScript API库,它提供了许多与bZx Network智能合约交互的方法,方便前端工程师...

    4 年前
  • npm 包 gatsby-source-github-feed 使用教程

    什么是 gatsby-source-github-feed gatsby-source-github-feed 是一个 npm 包,是用于 Gatsby 框架的源插件。

    4 年前
  • npm 包 vietnam-clone 使用教程

    Python 的 deep copy,JavaScript 的 spread operator 和 Java 的 clone 都是为了创建对象的深拷贝,即创建一个新的对象,具有与原始对象相同的属性和方...

    4 年前
  • npm 包 tabs-broadcast 使用教程

    什么是 tabs-broadcast tabs-broadcast 是一个基于 JavaScript 的 npm 包,用于在不同的浏览器标签页之间进行消息传递和状态同步。

    4 年前
  • npm 包 google-doc-to-pdf 使用教程

    在前端开发中,我们经常需要将 Google Doc 文档转换成 PDF 格式,以便实现更好的可视化和分享功能。但是,这个任务并不容易完成。好消息是,有一个名为 google-doc-to-pdf 的 ...

    4 年前
  • npm 包 eslint-plugin-number-literal-case 使用教程

    在前端开发中,经常会使用到 JavaScript 语言。在日常开发中,如果我们使用到数字类型的数据,那么就需要注意数字的字母大小写。这个时候,就可以使用 npm 包中的 eslint-plugin-n...

    4 年前
  • npm 包 @mongox/mxjs-tx 使用教程

    简介 @mongox/mxjs-tx 是一个用于 Node.js 环境下编写 MongoDB 事务操作的 npm 包。它提供了一种方便而安全的方式来处理 MongoDB 的事务操作。

    4 年前
  • npm 包 q4web 使用教程

    引言 Q4web 是一个 JavaScript 库,它提供了一套扩展管理和展示 Tabular Fashion 格式数据的方法,使得我们可以更加灵活地展示数据。在本文中,我们将学习如何使用 npm 包...

    4 年前
  • npm 包 insult 使用教程

    在前端开发的过程中,我们经常需要使用各种第三方资源来提高开发效率和质量。npm 是目前最流行的 JavaScript 包管理器,提供了丰富的开源包库。本文将介绍一款 npm 包——insult,它可以...

    4 年前
  • npm 包 proxy2mock 使用教程

    在前端开发中,经常会遇到需要在本地使用模拟数据的情况,这就涉及到 mock 数据的问题。在这个问题上,npm 包 proxy2mock 提供了一种简易、方便的解决方案。

    4 年前
  • npm 包 m5ui 使用教程

    前端开发中,经常需要使用 UI 库来快速构建界面和交互,而 npm 包 m5ui 提供了一套基于 Vue.js 的轻量级 UI 组件库,可以帮助开发者更快速地搭建应用。

    4 年前
  • npm 包 scilla-data-parser 使用教程

    在前端开发中,数据解析是一项基本且必要的任务。npm 包 scilla-data-parser 就是一个优秀的数据解析工具,它提供了一种高效且简单的方式来解析和处理 Scilla 数据。

    4 年前
  • npm包vue-carousel-3d-update使用教程

    简介 vue-carousel-3d-update 是 Vue.js 的一个npm包,用于在网页中制作 3D 旋转木马轮播效果。它可以为你的网站增添生动、炫酷的特效,使用户体验更为丰富和愉悦。

    4 年前
  • npm 包 fast-catch-linashen 使用教程

    fast-catch-linashen 是一个简单易用的轻量级 npm 包,可以用于 JavaScript 项目中处理和捕获异常。本教程将详细介绍 fast-catch-linashen 的使用方法,...

    4 年前
  • npm 包 @conveyal/taui 使用教程

    导入包的目的 在前端开发中,我们通常需要各种工具和框架来辅助我们开发。使用 npm 包的好处在于,我们可以直接在我们的项目中引入需要的库或工具。在这个文章中,我们将介绍一个前端库 @conveyal/...

    4 年前
  • npm 包 hexo-ruby-character-ex 使用教程

    简介 在前端开发中,有时候需要在网页中添加注音符号来帮助用户正确地阅读汉字。hexo-ruby-character-ex 就是一款能够帮助我们快速实现注音符号渲染的 npm 包。

    4 年前

相关推荐

    暂无文章