docs-website/themes/next/docs/ALGOLIA-SEARCH.md

In epiforecasts/crowdforecastr: Eliciting crowd forecasts in R shiny

Algolia Search

NexT provides Algolia search plugin for index your hexo website content. To use this feature, make sure that the version of NexT you are using is after the v5.1.0 release. What you should note here is that only turn on enable of algolia_search in next/_config.yml cannot let you use the algolia search correctly, you need to install corresponding Hexo Algolia plugin to seach your website with Algolia. Follow the steps described below to complete the installation of Algolia search.

1. Register at Algolia, you can log in directly using GitHub or Google Account. Upon Customer’s initial sign-up for an Account, Customer will have a free, fourteen (14) day evaluation period (the “Evaluation Period”) for the Algolia Services commencing on the Effective Date, subject to the limitations on Algolia’s website. After that, Algolia offers a free, branded version for up to 10k records and 100k operations per month.

2. If a tutorial pops up, you can skip it. Go straight to create an Index which will be used later.

   

3. Go to the API Keys page and find your credentials. You will need the Application ID and the Search-only API key in the following sections. The Admin API key need to keep confidential. Never store your Admin API Key as apiKey in the_config.yml file: it would give full control of your Algolia index to others and you don't want to face the consequences.

   

4. In your site's _config.yml, add the following configuration and replace the applicationID & apiKey & indexName with corresponding fields obtained at Algolia.

   yml algolia: applicationID: 'Application ID' apiKey: 'Search-only API key' indexName: 'indexName' chunkSize: 5000

5. In the API Keys page, click the All API Keys button to switch to the corresponding tab. Then click the New API Key button to activate a pop-up box where you can setup authorizations and restrictions with a great level of precision. Enter addObject, deleteObject, listIndexes, deleteIndex features in ACL permissions that will be allowed for the given API key. And then click the Create button. Copy this newly created key to the clipboard, we call it a High-privilege API key.

   

6. Algolia requires users to upload their search index data either manually or via provided APIs. Install and configure Hexo Algolia in your Hexo directory. This plugin will index your site and upload selected data to Algolia.

   $ cd hexo $ npm install hexo-algolia

7. Run the following command to upload index data, keep a weather eye out the output of the command.

   ``` $ export HEXO_ALGOLIA_INDEXING_KEY=High-privilege API key # Use Git Bash

   set HEXO_ALGOLIA_INDEXING_KEY=High-privilege API key # Use Windows command line

   $ hexo clean $ hexo algolia ```

   

8. In next/_config.yml, turn on enable of algolia_search. At the same time, you need to turn off other search plugins like Local Search. You can also adjust the text in labels according to your needs.

   ```yml

   Algolia Search

   algolia_search: enable: true hits: per_page: 10 labels: input_placeholder: Search for Posts hits_empty: "We didn't find any results for the search: ${query}" hits_stats: "${hits} results found in ${time} ms" ```

9. If you want to use a different version from CDN, please follow the instructions below.

   You need to set vendors in NexT _config.yml file: yml vendors: ... # Algolia Search # algolia_search: //cdn.jsdelivr.net/npm/algoliasearch@4/dist/algoliasearch-lite.umd.js # instant_search: //cdn.jsdelivr.net/npm/instantsearch.js@4/dist/instantsearch.production.min.js algolia_search: //cdn.jsdelivr.net/npm/algoliasearch@4/dist/algoliasearch-lite.umd.js instant_search: //cdn.jsdelivr.net/npm/instantsearch.js@4/dist/instantsearch.production.min.js ...

Known Issues

1. The latest version of the Hexo-Algolia plugin removes the content indexing feature, given Algolia's free account limitation.

2. The Hexo-Algoliasearch plugin provides content indexing functionality, but requires the replacement of keywords in the NEXT theme. The same problem exists with Record Too Big for Algolia's free account.

   • Replace all applicationID in source/js/algolia-search.js with appId
   • Replace all applicationID in layout/_partials/head/head.swig with appId

epiforecasts/crowdforecastr documentation built on June 23, 2021, 10:30 p.m.