# JekyllSearch

[![build](https://img.shields.io/travis/choffmeister/jekyll_search/develop.svg)](https://travis-ci.org/choffmeister/jekyll_search)
[![gem](https://img.shields.io/gem/v/jekyll_search.svg)](https://rubygems.org/gems/jekyll_search)
[![license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](http://opensource.org/licenses/MIT)

## Live demo

See it in action on my [blog](http://choffmeister.de/search.html).

## Installation

Add this line to your application's Gemfile:

```ruby
source 'https://rubygems.org'

group :jekyll_plugins do
  gem 'jekyll_search'
end
```

or for bleeding edge:

```ruby
group :jekyll_plugins do
  gem 'jekyll_search', :git => 'https://github.com/choffmeister/jekyll_search.git', :branch => 'develop'
end
```

And then execute:

    $ bundle

## Usage

First you need a machine with [Elasticsearch][elasticsearch] installed. Then configure the search plugin by adding
the following entries into your Jekyll `_config.yml` (replace the `host` entry if needed):

```yaml
# Search index settings
search:
  host: localhost:9200
  index:
    name: myindex
```

Now run `jekyll index` to iterate over all pages and index them with Elasticsearch. With `jekyll search my query`
you can throw some test searches against your freshly created search index. When you plan to integrate a AJAX
based search into your Jekyll page, then the following `curl` example should help to get started (see also [here][elasticsearch-searchapi]):

```text
curl -XPOST localhost:9200/myindex/section/_search?pretty -d '{
  "query": {
    "match_phrase_prefix": {
      "content": {
        "query": "I SEARCH FOR SOMETHING",
        "slop": 10
      }
    }
  },
  "highlight": {
    "fields": {
      "content": {}
    }
  }
}'
```

```json
{
  // ...
  "hits": {
    "total": 7,
    "max_score": 0.61569,
    "hits": [
      {
        // ...
        "_score" : 0.61569,
        "_source": {
          "url": "/link-to-page.html#headline-id",
          "title": "The title",
          "content": "The content"
        },
        "highlight": {
          "content": [
            "Some <em>highlighted</em> stuff"
          ]
        }
      }
      // ...
    ]
  }
  // ...
}
```

## Customize search index

If you want to customize how Elasticsearch creates the search index, then provide an additional `index.settings`
property in your `_config.yml` (see also [here][elasticsearch-createindex]):

```yaml
# Search index settings
search:
  host: localhost:9200
  index:
    name: myindex
    settings:
      mappings:
        page:
          properties:
            url:
              type: string
              analyzer: keyword
            title:
              type: string
              analyzer: english
            content:
              type: string
              analyzer: english
        section:
          properties:
            url:
              type: string
              analyzer: keyword
            title:
              type: string
              analyzer: english
            content:
              type: string
              analyzer: english
```

## Contributing

1. Fork it ( https://github.com/choffmeister/jekyll_search/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

[elasticsearch]: http://www.elasticsearch.org/
[elasticsearch-searchapi]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html
[elasticsearch-createindex]: http://www.rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Indices/Actions#create-instance_method