简介
docsearch.js 是一个开源的 JavaScript 库，可以方便地为你的文档站点提供搜索功能。它支持多种搜索引擎，例如 Algolia、Elasticsearch、Lunr 等等，并且可以定制化搜索结果的显示样式。
安装
首先，你需要在你的项目中安装 docsearch.js。你可以通过 npm 来进行安装：
npm install docsearch.js --save
也可以通过 CDN 直接引入：
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2.0.1/dist/cdn/docsearch.min.js"></script>
使用指南
初始化
初始化 docsearch.js 很简单，你只需要调用 docsearch() 方法，传入以下参数：
options（必填）：搜索选项，包括apiKey、indexName、inputSelector等等。callback（可选）：回调函数，在搜索结束后会被调用。
下面是一个示例代码：
docsearch({
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME',
inputSelector: '#search-input'
});其中，apiKey 和 indexName 参数分别对应着你的搜索引擎的 API Key 和索引名称。你需要将它们替换成你自己的值。
inputSelector 参数则表示搜索框的选择器，这个值需要和 HTML 中对应的元素的 ID 或 class 相同。
定制化
docsearch.js 还支持多种定制化选项，可以让你更加灵活地控制搜索结果的样式等等。以下是一些常用的选项：
debug：是否开启调试模式，默认为 false。autocompleteOptions：自动补全选项，可以设置补全框的位置、最大显示数量等等。handleSelected：处理选中项的回调函数，可以根据选中项做出相应的操作。
下面是一个示例代码：
-- -------------------- ---- -------
-----------
------- ---------------
---------- ------------------
-------------- ----------------
------ -----
-------------------- -
------------ -----
----- -----
--------- --------------------
----------- -
--
--------------- --------------- ------ ----------- -
------------------------
-
---支持多语言
docsearch.js 支持多语言搜索，你可以通过 language 参数来指定语言。当前支持的语言有英语、法语、德语、意大利语、日语、韩语、葡萄牙语、俄语、中文（简体和繁体）。
以下是一个示例代码：
docsearch({
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME',
inputSelector: '#search-input',
language: 'zh'
});总结
docsearch.js 是一个方便易用的搜索库，可以帮助你快速地在文档站点中添加搜索功能。同时，它还支持多种定制化选项和多语言搜索，让你的搜索体验更加出色。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/36257