-
-The search plugins of Icarus are provided by
-[ppoffice/hexo-component-inferno](https://github.com/ppoffice/hexo-component-inferno).
-Please refer to it for a complete list of supported plugins and their configurations.
-
+
+
+
+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
@@ -36,13 +40,20 @@ Please refer to it for a complete list of supported plugins and their configurat
Hexo site.
2. Register and log into [Algolia](https://www.algolia.com/).
- Click "Create Index" button on the dashboard when you log in for the first time.
- Then, enter the name of Index (Index name) and click the "Create" button to complete index creation.
+ 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 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.
- For example, the following Aloglia index information
+
+ {% img "box 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
@@ -50,7 +61,7 @@ Please refer to it for a complete list of supported plugins and their configurat
Search-Only API Key: 7b08fca7d42412cee901a25643124221
{% endcodeblock %}
- can be mapped to the following plugin configuration
+ maps to the following plugin configuration:
{% codeblock _config.yml lang:yaml %}
algolia:
@@ -61,39 +72,41 @@ Please refer to it for a complete list of supported plugins and their configurat
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 your created in the last step in "Indices" select box.
- Then, type the domain name of your site to the "HTTP Referers" field and add `addObject`, `deleteObject`,
- `listIndexes`, `deleteIndex` to the "ACL" field.
+ 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 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 environment variable used by the hexo-algolia plugin when upload the indices to Algolia to the
- API key you created in the last step.
+ 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
+ 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
+ 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
+ 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, open theme configuration file and set the search engine to Algolia
+6. Finally, set the search engine to Algolia in your theme configurations:
{% codeblock themes/icarus/_config.yml lang:yaml %}
search:
@@ -105,7 +118,7 @@ Please refer to it for a complete list of supported plugins and their configurat
**Installation Guide**
-1. Open theme configuration file and set the set the search engine to Baidu
+1. Open theme configuration file and set search engine to Baidu:
{% codeblock themes/icarus/_config.yml lang:yaml %}
search:
@@ -121,19 +134,28 @@ Please refer to it for a complete list of supported plugins and their configurat