github
/
hexo-theme-icarus
mirror of https://github.com/ppoffice/hexo-theme-icarus
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
hexo-theme-icarus/source/_posts/en/Search-Plugins.md

6.4 KiB
Raw Blame History

title: Icarus User Guide - Search Plugin date: 2017-01-31 categories:

  • Plugins
  • Search tags:
  • Icarus User Guide language: en toc: true

This article covers search plugin configurations supported by Icarus 3.

This article is also available in 简体中文.
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.

    {% img "box px-0 py-0 ml-auto mr-auto" /gallery/screenshots/algolia-create-index.png 360 '"Create Index - Algolia" "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.

    {% img "box px-0 py-0 ml-auto mr-auto" /gallery/screenshots/algolia-api-keys.png 360 '"API Keys - Algolia" "API Keys - Algolia"' %}

    For example, the following Aloglia index information:

    {% codeblock "Algolia Index Information" %} Algolia Index Name: My-Hexo-Site Application ID: ABCDEFGHIJKL Search-Only API Key: 7b08fca7d42412cee901a25643124221 {% endcodeblock %}

    maps to the following plugin configuration:

    {% codeblock _config.yml lang:yaml %} algolia: applicationID: My-Hexo-Site indexName: ABCDEFGHIJKL apiKey: 7b08fca7d42412cee901a25643124221 {% endcodeblock %}

  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.

    {% img "box px-0 py-0 ml-auto mr-auto" /gallery/screenshots/algolia-create-api-key.png 360 '"Create API Key - Algolia" "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:

    {% codeblock "Windows Command Prompt (CMD)" lang:cmd %} C:\Users\you> cd path/to/your/hexo/site C:\Users\you> set HEXO_ALGOLIA_INDEXING_KEY="727fbd8c998fe419318fa350db6793ca" {% endcodeblock %}

    On Linux/macOS:

    {% codeblock "Linux/macOS Terminal" lang:shell %} $ cd path/to/your/hexo/site $ export HEXO_ALGOLIA_INDEXING_KEY="727fbd8c998fe419318fa350db6793ca" {% endcodeblock %}

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

    {% codeblock "Windows Command Prompt or Linux/macOS Terminal" lang:shell %} $ hexo clean $ hexo algolia {% endcodeblock %}

  6. Finally, set the search engine to Algolia in your theme configurations:

    {% codeblock themes/icarus/_config.yml lang:yaml %} search: type: algolia {% endcodeblock %}

Baidu Search

Installation Guide

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

    {% codeblock themes/icarus/_config.yml lang:yaml %} search: type: baidu {% endcodeblock %}

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.

    {% img "box px-0 py-0 ml-auto mr-auto" /gallery/screenshots/google-cse-create.png 360 '"Create Custom Search - Google CSE" "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 configuration file.

    {% img "box px-0 py-0 ml-auto mr-auto" /gallery/screenshots/google-cse-code.png 360 '"Get Code - Google CSE" "Get Code - Google CSE"' %}

    For example, the following HTML code:

    {% codeblock "Google CSE HTML code" lang:html %}

    {% endcodeblock %}

    maps to the following theme configuration:

    {% codeblock themes/icarus/_config.yml lang:yaml %} search: type: google_cse cx: 012345601234560123456:abcdefghijklmn {% endcodeblock %}

Insight

Installation Guide

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

    {% codeblock themes/icarus/_config.yml lang:yaml %} search: type: insight {% endcodeblock %}

Something wrong with this article? Click here to submit your revision.