lunr.js - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #android #macos #java #awesome #cli #awesome-list #vue #security #ios

lunr.js

(★ 9,200)

A bit like Solr, but much smaller and not as bright

파일 탐색기

최종 버전 다운로드 (.zip)

- bower.json.template
- component.json.template
- jsdoc.conf.json
- package.json.template
- release.sh
- wrapper_end
- wrapper_start
- builder.js
- field_ref.js
- idf.js
- index.js
- lunr.js
- match_data.js
- pipeline.js
- query.js
- query_lexer.js
- query_parse_error.js
- query_parser.js
- set.js
- stemmer.js
- stop_word_filter.js
- token.js
- token_set.js
- token_set_builder.js
- tokenizer.js
- trimmer.js
- utils.js
- vector.js
- builder_perf.js
- perf_helper.js
- pipeline_perf.js
- query_parser_perf.js
- search_perf.js
- stemmer_perf.js
- token_set_perf.js
- tokenizer_perf.js
- vector_perf.js
- - chai.js
  - index.mustache
  - mocha.css
  - mocha.js
- - stemming_vocab.json
- builder_test.js
- field_ref_test.js
- index.html
- match_data_test.js
- pipeline_test.js
- query_lexer_test.js
- query_parser_test.js
- query_test.js
- search_test.js
- serialization_test.js
- set_test.js
- stemmer_test.js
- stop_word_filter_test.js
- test_helper.js
- token_set_test.js
- token_test.js
- tokenizer_test.js
- trimmer_test.js
- utils_test.js
- vector_test.js
.eslintrc.json
.gitignore
.travis.yml
CHANGELOG.md
CNAME
CONTRIBUTING.md
index.html
LICENSE
lunr.js
Makefile
notes
package.json
README.md
styles.css
VERSION

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/olivernn/lunr.js

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd lunr.js

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

3. Make

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Lunr.js

[![Join the chat at https://gitter.im/olivernn/lunr.js](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/olivernn/lunr.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/olivernn/lunr.js.svg?branch=master)](https://travis-ci.org/olivernn/lunr.js)

A bit like Solr, but much smaller and not as bright.

## Example

A very simple search index can be created using the following:

```javascript
var idx = lunr(function () {
  this.field('title')
  this.field('body')

this.add({
    "title": "Twelfth-Night",
    "body": "If music be the food of love, play on: Give me excess of it…",
    "author": "William Shakespeare",
    "id": "1"
  })
})
```

Then searching is as simple as:

```javascript
idx.search("love")
```

This returns a list of matching documents with a score of how closely they match the search query as well as any associated metadata about the match:

```javascript
[
  {
    "ref": "1",
    "score": 0.3535533905932737,
    "matchData": {
      "metadata": {
        "love": {
          "body": {}
        }
      }
    }
  }
]
```

[API documentation](https://lunrjs.com/docs/index.html) is available, as well as a [full working example](https://olivernn.github.io/moonwalkers/).

## Description

Lunr.js is a small, full-text search library for use in the browser.  It indexes JSON documents and provides a simple search interface for retrieving documents that best match text queries.

## Why

For web applications with all their data already sitting in the client, it makes sense to be able to search that data on the client too.  It saves adding extra, compacted services on the server.  A local search index will be quicker, there is no network overhead, and will remain available and usable even without a network connection.

## Installation

Simply include the lunr.js source file in the page that you want to use it.  Lunr.js is supported in all modern browsers.

Alternatively an npm package is also available `npm install lunr`.

Browsers that do not support ES5 will require a JavaScript shim for Lunr to work. You can either use [Augment.js](https://github.com/olivernn/augment.js), [ES5-Shim](https://github.com/kriskowal/es5-shim) or any library that patches old browsers to provide an ES5 compatible JavaScript environment.

## Features

* Full text search support for 14 languages
* Boost terms at query time or boost entire documents at index time
* Scope searches to specific fields
* Fuzzy term matching with wildcards or edit distance

## Contributing

See the [`CONTRIBUTING.md` file](CONTRIBUTING.md).