NexT provides Algolia search plugin for index your hexo website content. What you should note here is that only turn on
algolia_search in theme config file 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.
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.
If a tutorial pops up, you can skip it. Go straight to create an
Indexwhich will be used later.
Go to the
API Keyspage and find your credentials. You will need the
Application IDand the
Search-only API keyin the following sections. The
Admin API keyneed to keep confidential. Never store your Admin API Key as
apiKeyin theme config file: it would give full control of your Algolia index to others and you don't want to face the consequences.
API Keyspage, click the
ALL API KEYSand the
editoption in the created APIKEY to activate a pop-up box where you can setup authorizations and restrictions with a great level of precision. Check
Delete indexfeatures in ACL permissions that will be allowed for the given API key. And then click the
In your site config file, add the following configuration and replace the
indexName with corresponding fields obtained at Algolia.
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
Run the following command to upload index data, keep a weather eye out the output of the command.
$ export HEXO_ALGOLIA_INDEXING_KEY=Search-Only API key # Use Git Bash
# set HEXO_ALGOLIA_INDEXING_KEY=Search-Only API key # Use Windows command line
$ hexo clean
$ hexo algolia
If you want to use a different version from CDN, please follow the instructions below.
You need to set vendors in theme config file:
In theme config file, turn on
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.
# Algolia Search
- The latest version of the Hexo-Algolia plugin removes the content indexing feature, given Algolia's free account limitation.
- 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 Bigfor Algolia's free account.
- Replace all
- Replace all
- Replace all
Local search no need any external 3rd-party services and can be extra indexed by search engines. That search method recommended for most users.
hexo-generator-searchdb by run following command in site root dir:
$ npm install hexo-generator-searchdb
Edit site config file and add following content:
Edit theme config file to enable Local Search:
# Local search
Go to Swiftype Sign Page to sign up.
After signing up create a new search engine and follow instructions.
After creating choose
Install Search in the menu to customize with instructions. Then click
Active button finally.
INSTALL CODE and copy your
Change Configuration →
Search Field, then follow the instructions.
Edit theme config file and fill section
swiftype_key with value of your key gets:
# Swiftype Search API Key