Icarus User Guide - Search Plugin

This article covers search plugin configurations supported by Icarus 4.

The following search plugins are provided by ppoffice/hexo-component-inferno. Please refer to it for a complete list of supported plugins and their configuration details.

Algolia

Installation GuidePreview
  1. Install the hexo-algolia plugin under the root directory of your Hexo site.

  2. Register and log into Algolia. Click the “Create Index” button on the dashboard when you log in for the first time. Then, enter the name of the index and click the “Create” button to complete index creation.

    Create Index - Algolia
  3. Next, click “API Keys” on the left navigation bar, copy “Application ID” and “Search-Only API Key” on the page. Open site configuration file _config.yml under the root directory of your Hexo site and fill in the above information to the hexo-algolia plugin configurations.

    API Keys - Algolia

    For example, the following Aloglia index information:

    Algolia Index Information
    1
    2
    3
    Algolia Index Name: My-Hexo-Site
    Application ID: ABCDEFGHIJKL
    Search-Only API Key: 7b08fca7d42412cee901a25643124221

    maps to the following plugin configuration:

    _config.yml
    1
    2
    3
    4
    algolia:
    applicationID: My-Hexo-Site
    indexName: ABCDEFGHIJKL
    apiKey: 7b08fca7d42412cee901a25643124221
  4. Go back to the “API Keys” page from the Algolia dashboard and switch to the “All API Keys” tab. Click the “New API Key” button. On the popup “Create API Key” dialog, select the index you created in the last step in “Indices” select box. Then, add addObject, deleteObject, listIndexes, deleteIndex to the “ACL” field. Click the “Create” button to finish key creation. Copy the API key you just created, e.g., 727fbd8c998fe419318fa350db6793ca.

    Create API Key - Algolia
  5. Open a Windows Command Prompt (CMD) or Linux/macOS terminal and change the working directory to the root directory of your Hexo site. Set the HEXO_ALGOLIA_INDEXING_KEY environment variable to the API key you created in the last step. This variable is used by hexo-algolia when uploading indices to Algolia.

    On Windows:

    Windows Command Prompt (CMD)
    1
    2
    C:\Users\you> cd path/to/your/hexo/site
    C:\Users\you> set HEXO_ALGOLIA_INDEXING_KEY=727fbd8c998fe419318fa350db6793ca

    On Linux/macOS:

    Linux/macOS Terminal
    1
    2
    $ cd path/to/your/hexo/site
    $ export HEXO_ALGOLIA_INDEXING_KEY="727fbd8c998fe419318fa350db6793ca"

    Then, run the following commands to clean up your site and upload indices to Algolia:

    Windows Command Prompt or Linux/macOS Terminal
    1
    2
    $ hexo clean
    $ hexo algolia
  6. Finally, set the search engine to Algolia in your theme configurations:

    _config.icarus.yml
    1
    2
    search:
    type: algolia

Installation Guide

  1. Open theme configuration file and set search engine to Baidu:

    _config.icarus.yml
    1
    2
    search:
    type: baidu

Google Custom Search Engine (CSE)

Installation GuidePreview
  1. Log into your Google account and visit Google CSE to create a CSE. Type in the URL of your site (without http:// or https://) in the “Sites to Search” field. Select the correct language from the “Language” select box. Then, fill in the “Name of the search engine”. Click the “Create” button to finish engine creation.

    Create Custom Search - Google CSE
  2. Then, click the “Get code” button on the right side of “Add it to your site”. Copy the value of cx to the search settings in your theme’s configurations.

    Get Code - Google CSE

    For example, the following HTML code:

    Google CSE HTML code
    1
    2
    <script async src="https://cse.google.com/cse.js?cx=012345601234560123456:abcdefghijklmn"></script>
    <div class="gcse-search"></div>

    maps to the following theme configuration:

    _config.icarus.yml
    1
    2
    3
    search:
    type: google_cse
    cx: 012345601234560123456:abcdefghijklmn

Insight

Installation Guide

  1. Insight is the default search engine of this site. You can enable it using the following theme configuration:

    _config.icarus.yml
    1
    2
    search:
    type: insight
Something wrong with this article? Click here to submit your revision.
Author

PPOffice

Posted on

2017-01-31

Licensed under

CC BY-NC-SA 4.0

Your browser is out-of-date!

Update your browser to view this website correctly.&npsb;Update my browser now

×