Project

searchyll

0.03
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
searchyllomc/searchyllHomepageDocumentationSource CodeBug TrackerWiki
A gem to index your Jekyll pages into Elasticsearch.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
85,444
Stars
48
Forks
13
Watchers
5
 Releases
Current version
0.10.2
Total releases
3
First release
2016-05-07
Latest release
2018-06-30
 Issues
Open Issues
9
Closed Issues
14
Total Issues
23
Issue Closure Rate
60%
 Pull Requests
Open Pull Requests
3
Closed Pull Requests
7
Merged Pull Requests
20
Pull Request Acceptance Rate
66%
 Development
Primary Language
Ruby
Licenses
GPL-3.0
Average date of last 50 commits
2018-06-08
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.10
guard-rspec
>= 0
rake
~> 10.0
rspec
>= 0

Runtime

jekyll
>= 3.0
nokogiri
>= 0
 Project Readme

Searchyll

Search for Jekyll apps. A plugin for indexing your pages into a search engine.

Currently supports Elasticsearch, we're also considering modular support for Apache Solr in a future release.

Installation

Add this line to your application's Gemfile:

gem 'searchyll'

In your Jekyll Gemfile:

gems:
  - searchyll

Configuration

elasticsearch:
  url: "http://localhost:9200/"     # Required. Supports auth and SSL: https://user:pass@someurl.com
                                    # Can also read URLs stored in environment variable named
                                    # BONSAI_URL and ELASTICSEARCH_URL.
  number_of_shards: 1               # Optional. Default is 1 primary shard.
  number_of_replicas: 1             # Optional. Default is 1 replica.
  index_name: "jekyll"              # Optional. Default is "jekyll".
  default_type: "post"              # Optional. Default type is "post".
  custom_settings: _es_settings.yml # Optional. No default. Relative to your src folder
  custom_mappings: _es_mappings.yml # Optional. No default. Relative to your src folder
  ignore:                           # Optional. No default.
    - /news/*

Custom Settings File Example

It should be written to be plugged into the settings slot of a create index call

analysis:
  analyzer:
    stop_analyzer:
      type: stop
      stopwords: _english_
index:
  number_of_shards: 1
  number_of_replicas: 0

Custom Mappings File Example

It should be written to be plugged into the mappings.[type] slot of a create index call

properties:
  field1:
    type: text

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/omc/searchyll