简介
在 GitBook 中,搜索功能是十分重要的。然而,由于 GitBook 自带的搜索插件功能并不十分完善,因此,有许多第三方插件来填补这个功能空缺。在这篇技术文章中,我们将介绍一款优秀的 GitBook 搜索插件 —— gitbook-plugin-search-pro-fixed,并将详细说明它的使用方法。
安装
1、首先,你需要进入你的 GitBook 插件目录中。
$ cd /your-gitbook/directory/plugins
2、通过 npm 安装 gitbook-plugin-search-pro-fixed 插件。
$ npm install gitbook-plugin-search-pro-fixed --save
3、GitBook 3.0.0 版本及以上需要在 book.json 文件中注册插件。
{ "plugins": ["gitbook-plugin-search-pro-fixed"] }
如果你的 GitBook 版本低于 3.0.0,可以直接在 book.json 文件中添加如下配置项:
-- -------------------- ---- ------- - ---------------- - --------- - ---------- ----- --------- --------- -------- - - - -
使用
安装完 gitbook-plugin-search-pro-fixed 插件后,你需要启用搜索功能。你可以使用以下步骤来实现。
1、在你的 GitBook 配置文件中打开搜索功能。
{ "variables": {}, "plugins": ["-search-pro"], "pluginsConfig": { "disqus": {} } }
2、使用搜索功能,并添加搜索窗口。
{% search %}
3、保存配置文件后,从命令行重新生成你的书籍。
$ gitbook build
安装和配置之后,你可以在你的 GitBook 页面上看到搜索框,并进行搜索操作。不同之处是,gitbook-plugin-search-pro-fixed 支持针对多个语言(支持的语言和搜索范围可在配置文件中配置)进行搜索。
示例代码
以下是一个关于在 GitBook 中使用 gitbook-plugin-search-pro-fixed 插件的示例代码:
{% search %}
-- -------------------- ---- ------- - ---------- ------------------------------------ ---------------- - --------- - -------- --------- ----------- ------- ------ ----- -- --------- - ------------ ----- ------ ---------- - - -
总结
通过以上的步骤,你可以轻松地在 GitBook 中使用 gitbook-plugin-search-pro-fixed 插件。这个插件能够增强 GitBook 的搜索功能,帮助你更好地查找到你想要的信息。希望本文可以对你的学习和工作有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006725e3660cf7123b3642d