npm 包 gitbook-plugin-search-pro-fixed 的使用教程

简介

在 GitBook 中,搜索功能是十分重要的。然而,由于 GitBook 自带的搜索插件功能并不十分完善,因此,有许多第三方插件来填补这个功能空缺。在这篇技术文章中,我们将介绍一款优秀的 GitBook 搜索插件 —— gitbook-plugin-search-pro-fixed,并将详细说明它的使用方法。

安装

1、首先,你需要进入你的 GitBook 插件目录中。

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

2、通过 npm 安装 gitbook-plugin-search-pro-fixed 插件。

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

3、GitBook 3.0.0 版本及以上需要在 book.json 文件中注册插件。

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

如果你的 GitBook 版本低于 3.0.0,可以直接在 book.json 文件中添加如下配置项:

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

使用

安装完 gitbook-plugin-search-pro-fixed 插件后,你需要启用搜索功能。你可以使用以下步骤来实现。

1、在你的 GitBook 配置文件中打开搜索功能。

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

2、使用搜索功能,并添加搜索窗口。

-- ------ --

3、保存配置文件后,从命令行重新生成你的书籍。

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

安装和配置之后,你可以在你的 GitBook 页面上看到搜索框,并进行搜索操作。不同之处是,gitbook-plugin-search-pro-fixed 支持针对多个语言(支持的语言和搜索范围可在配置文件中配置)进行搜索。

示例代码

以下是一个关于在 GitBook 中使用 gitbook-plugin-search-pro-fixed 插件的示例代码:

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

总结

通过以上的步骤,你可以轻松地在 GitBook 中使用 gitbook-plugin-search-pro-fixed 插件。这个插件能够增强 GitBook 的搜索功能,帮助你更好地查找到你想要的信息。希望本文可以对你的学习和工作有所帮助。

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


猜你喜欢

  • npm 包 @pile-ui/shared 使用教程

    前言 npm 是 Node.js 的包管理器,可以方便地安装和管理 JavaScript 包。@pile-ui/shared 是一款优秀的 npm 包,提供了一些常用的前端工具函数和组件,为前端开发者...

    4 年前
  • npm 包 @pile-ui/theme-default 使用教程

    简介 npm 是 Node Package Manager 的简称,是 Node.js 管理包的工具。通过 npm 我们可以方便地下载已有的 Node.js 包并快速的安装使用。

    4 年前
  • npm 包 @pile-ui/validator 使用教程

    简介 @pile-ui/validator 是一个基于 validator.js 的表单验证工具包,专门为前端开发人员设计,可以轻松地进行表单验证,节省时间和精力。

    4 年前
  • npm 包 @pile-ui/condition 使用教程

    在前端开发中,我们经常需要对数据进行筛选、排序等操作。@pile-ui/condition 是一款可以帮助我们快速生成筛选、排序等功能的组件库,使用简便,功能强大。

    4 年前
  • npm包 @pile-ui/local-provider使用教程

    前言 @pile-ui/local-provider是一款基于React的本地化组件库。它允许开发者在应用程序中运用这个库的组件,并根据需要灵活地进行选取。本篇文章将重点介绍如何使用npm包@pile...

    4 年前
  • npm 包 generator-touchpal-phaser 使用教程

    前言 generator-touchpal-phaser 是一款基于 Yeoman 构建的 TouchPal Phaser 模板生成器 ,可以帮助你在快速创建 Phaser-based 的 Touch...

    4 年前
  • npm 包 MillionBounce 使用教程

    介绍 MillionBounce 是一个轻量级的 JavaScript 库,用于实现网站上弹性球的动画效果。通过使用 MillionBounce,用户能够轻松地为其网站添加高质量的动态交互效果,提高用...

    4 年前
  • npm 包 ngx-drag-and-drop-list 使用教程

    前言 前端界面的交互性越来越受到重视,拖拽功能也成为常用解决方案之一。ngx-drag-and-drop-list 就是一款可以帮助前端工程师轻松实现拖拽功能的 npm 包。

    4 年前
  • npm 包 @pile-ui/alert 使用教程

    前言 在前端开发中,使用一些成熟的 UI 库能够提高工作效率,尤其是在项目中需要频繁使用类似的组件时。本篇文章介绍了一个非常有用的 npm 包 @pile-ui/alert,以下是该 npm 包的使用...

    4 年前
  • npm 包 @pile-ui/icon 使用教程

    在前端开发中,往往需要用到各种各样的图标来美化界面或提升用户操作体验。图标的设计和制作需要时间和专业技能,许多前端开发者因此选择使用已经制作好的图标资源库。其中,@pile-ui/icon 是一款能够...

    4 年前
  • npm 包 @pile-ui/button 使用教程

    前言 前端领域中,UI 组件库的开发日新月异,随之而来的是缩短开发周期、降低开发成本、提高代码质量等一系列好处。本文要介绍的就是一个前端 UI 组件库 @pile-ui/button ,它提供了一种使...

    4 年前
  • npm 包 @pile-ui/confirm 使用教程

    前言 在日常开发中,经常需要使用一些弹框组件来实现一些交互效果,比如确认框、提示框等。本文将介绍一种基于 npm 包 @pile-ui/confirm 的弹框组件,该组件具有易用性、灵活性、样式定制化...

    4 年前
  • npm 包 @pile-ui/switch 使用教程

    简介 @pile-ui/switch 是一个基于 React 的 UI 组件库中的 Switch 组件,该组件提供开关按钮的功能,可以通过点击或者拖动的方式实现打开和关闭状态的切换。

    4 年前
  • npm包 @pile-ui/radio使用教程

    前端开发中,我们经常会使用到各种不同的库和工具来增强我们的工作效率和代码质量。其中,npm作为最流行的Node.js包管理器之一,提供了非常丰富的开源软件库供我们使用。

    4 年前
  • npm 包 @pile-ui/inputfiled 使用教程

    介绍 @pile-ui/inputfiled 是一款基于 React 框架的 input 组件,它能够满足各种输入框的需求,包括文字和数字的输入、密码输入、邮箱地址的输入等。

    4 年前
  • npm 包 @pile-ui/toast 使用教程

    如果你是一个前端开发者,那么你一定知道 npm 是什么。npm 是 Node.js 的包管理器,它可以帮助开发者管理和分享自己的 JavaScript 代码,同时也可以方便地使用他人已经发布的 npm...

    4 年前
  • npm 包 pile-ui 使用教程

    在前端开发中,经常需要使用各种 UI 组件来实现设计稿的效果。而这些组件的开发和维护是十分繁琐的,难免会有一些困难。这时候,第三方库就发挥了作用,它可以帮助我们快速地完成我们的项目。

    4 年前
  • npm 包 @cookpi/core 使用教程

    在前端领域,npm 是一个必不可少的工具,可以方便我们管理和分享自己的代码,和使用他人的代码,提高开发效率。在 npm 上,有很多优秀的第三方库和组件,@cookpi/core 就是其中一个高质量的 ...

    4 年前
  • npm 包 @cookpi/app 使用教程

    介绍 @cookpi/app 是一款可用于快速搭建 React 应用的 npm 包,通过该包可以迅速构建出具有稳定性、可扩展性和高性能的前端应用。该包提供了一系列齐全的工具和组件,包括路由、状态管理、...

    4 年前
  • npm 包 @cookpi/utils 使用教程

    Npm 是 Node.js 默认的包管理器,它非常重要。因为通过 npm,开发者可以轻松地分享和使用他人的模块和工具。@cookpi/utils 是一个非常实用的 npm 包,本文将讲解如何使用它,并...

    4 年前

相关推荐

    暂无文章