https://github.com/abecms/abe-algolia
Abe plugin adding Algolia search engine to your website
https://github.com/abecms/abe-algolia
Last synced: 4 months ago
JSON representation
Abe plugin adding Algolia search engine to your website
- Host: GitHub
- URL: https://github.com/abecms/abe-algolia
- Owner: abecms
- License: mit
- Created: 2016-12-05T21:29:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T02:36:01.000Z (over 8 years ago)
- Last Synced: 2025-06-02T01:09:54.597Z (about 1 year ago)
- Language: HTML
- Size: 8.79 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# abe-algolia
Add search feature on your Abe frontend with Algolia
## Introduction
This plugin will index all you published content to Algolia so that you can add a search feature to your static frontend !
## Pre-requisites
An account on Algolia
## Configuration
Configure the Algolia parameters in your abe.json file.
```
"algolia":{
"active":"true",
"apiKey":"Secured API Key",
"applicationID":"your appid",
"index":"optional value"
}
```
you can deactivate this plugin by setting "active" to false
If you don't provide an "index" value, the plugin will take the name of your project directory
## How it works
### On your Abe CMS
Every time you publish a content, abe-algolia will publish the whole document to Algolia.
Every time you unpublish a content, abe-algolia will delete this content from Algolia.
The algolia console : /abe/plugin/abe-algolia/console
It will display the number of indexed posts in Algolia. You'll be able to launch a full index or reindex your blog with algolia.
### On your client
You'll find a specific recipe on this plugin here: https://github.com/abecms/recipe-algolia