开始

英文原地址

安装

  1. npm install lunr

在浏览器中使用：

  1. <script src="https://unpkg.com/lunr/lunr.js"></script>

为了简单起见，下面将使用 node.js 环境作为示例。同样的代码可以在任何 JavaScript 环境中工作。

创建索引

我们将在文档集合上创建一个简单的索引，然后对这些文档执行搜索。

首先，我们需要一个文档集合。文档是一个 JavaScript 对象。Lunr 使用它的标识符字段告诉我们集合中哪些文档匹配搜索，以及我们希望搜索的任何其他字段。

  1. var documents = [{
  2.   "name": "Lunr",
  3.   "text": "Like Solr, but much smaller, and not as bright."
  4. }, {
  5.   "name": "React",
  6.   "text": "A JavaScript library for building user interfaces."
  7. }, {
  8.   "name": "Lodash",
  9.   "text": "A modern JavaScript utility library delivering modularity, performance & extras."
  10. }]

我们将使用上面的文档数组来构建索引。我们想搜索文本字段，name字段就是我们的标识符。让我们定义索引并将这些文档添加到其中。

  1. var idx = lunr(function () {
  2.   this.ref('name')
  3.   this.field('text')
  5.   documents.forEach(function (doc) {
  6.     this.add(doc)
  7.   }, this)
  8. })

现在我们已经创建了索引，尝试搜索:

  1. idx.search("bright")

结论

上面的示例展示了如何用 Lunr 快速进行全文搜索。您可以了解更多关于 Lunr 索引所涉及的核心概念，探索 Lunr 提供的高级搜索功能，并了解如何定制 Lunr 以提供出色的搜索体验。