Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omc/searchyll
https://github.com/omc/searchyll
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/omc/searchyll
- Owner: omc
- License: gpl-3.0
- Created: 2016-04-22T17:12:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-18T11:39:42.000Z (about 3 years ago)
- Last Synced: 2024-10-18T08:39:12.354Z (25 days ago)
- Language: Ruby
- Size: 76.2 KB
- Stars: 48
- Watchers: 5
- Forks: 15
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jekyll-plugins - **Searchyll** - Index your Jekyll pages to Elasticsearch, and works with Github pages. (Search)
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:
```ruby
gem 'searchyll'
```
In your Jekyll Gemfile:
```
gems:
- searchyll
```
## Configuration
```yaml
elasticsearch:
url: "http://localhost:9200/" # Required. Supports auth and SSL: https://user:[email protected]
# 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html) call
```yaml
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](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html) call
```yaml
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