chore(doc): update en search plugin doc
parent
20fcf6979c
commit
b230af677f
|
@ -14,7 +14,7 @@ jobs:
|
|||
- cp _config.theme.yml themes/icarus/_config.yml
|
||||
- ([[ -e _config.page.yml ]] && cp _config.page.yml themes/icarus/) || true
|
||||
- ([[ -e _config.post.yml ]] && cp _config.post.yml themes/icarus/) || true
|
||||
# - hexo algolia
|
||||
- hexo algolia
|
||||
- hexo g
|
||||
deploy:
|
||||
provider: pages
|
||||
|
|
|
@ -26,13 +26,6 @@ donates:
|
|||
qrcode: /gallery/donate/wechat.jpg
|
||||
---
|
||||
|
||||
<article class="message message-immersive is-primary">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-globe-asia mr-2"></i>
|
||||
This article is also available in <a href="{% post_path zh-CN/Donation-Buttons %}">简体中文</a>.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
This article covers donation button configurations supported by Icarus 3.
|
||||
If you need to display multiple donation buttons at once, add individual button configuration
|
||||
to the `donates` array like the following:
|
||||
|
@ -47,6 +40,13 @@ donates:
|
|||
...
|
||||
{% endcodeblock %}
|
||||
|
||||
<article class="message message-immersive is-primary">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-globe-asia mr-2"></i>
|
||||
This article is also available in <a href="{% post_path zh-CN/Donation-Buttons %}">简体中文</a>.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
<!-- more -->
|
||||
|
||||
<article class="message message-immersive is-primary">
|
||||
|
|
|
@ -9,21 +9,25 @@ language: en
|
|||
toc: true
|
||||
---
|
||||
|
||||
<div class="notification is-success is-size-6">
|
||||
This article is also available in: <a href="{% post_path zh-CN/Search-Plugins %}">简体中文</a>.
|
||||
</div>
|
||||
This article covers search plugin configurations supported by Icarus 3.
|
||||
|
||||
This article covers some search plugins supported by Icarus 3.
|
||||
<article class="message message-immersive is-primary">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-globe-asia mr-2"></i>
|
||||
This article is also available in <a href="{% post_path zh-CN/Search-Plugins %}">简体中文</a>.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
<!-- more -->
|
||||
|
||||
<div class="notification is-link is-size-6">
|
||||
|
||||
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.
|
||||
|
||||
<article class="message message-immersive is-primary">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-info-circle mr-2"></i>
|
||||
The following search plugins are provided by
|
||||
<a href="https://github.com/ppoffice/hexo-component-inferno">ppoffice/hexo-component-inferno</a>.
|
||||
Please refer to it for a complete list of supported plugins and their configuration details.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
## 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"' %}
|
||||
<br>
|
||||
|
||||
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"' %}
|
||||
<br>
|
||||
|
||||
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"' %}
|
||||
<br>
|
||||
|
||||
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
|
|||
</div>
|
||||
|
||||
1. Log into your Google account and visit [Google CSE](https://cse.google.com/cse/create/new) to create a CSE.
|
||||
Type in the domain name of your site in the "Sites to Search" field, select correct language from the "Language"
|
||||
select box, and fill in the "Name of the search engine". Click the "Create" button to finish engine creation.
|
||||
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 ml-auto mr-auto" /gallery/screenshots/google-cse-create.png 360 '"Create Custom Search - Google CSE" "Create Custom Search - Google CSE"' %}
|
||||
<br>
|
||||
|
||||
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.
|
||||
For example, the following HTML code
|
||||
|
||||
{% img "box ml-auto mr-auto" /gallery/screenshots/google-cse-code.png 360 '"Get Code - Google CSE" "Get Code - Google CSE"' %}
|
||||
<br>
|
||||
|
||||
For example, the following HTML code:
|
||||
|
||||
{% codeblock "Google CSE HTML code" lang:html %}
|
||||
<script async src="https://cse.google.com/cse.js?cx=012345601234560123456:abcdefghijklmn"></script>
|
||||
<div class="gcse-search"></div>
|
||||
{% endcodeblock %}
|
||||
|
||||
can be mapped to the following theme configuration
|
||||
maps to the following theme configuration:
|
||||
|
||||
{% codeblock themes/icarus/_config.yml lang:yaml %}
|
||||
search:
|
||||
|
@ -147,7 +169,7 @@ Please refer to it for a complete list of supported plugins and their configurat
|
|||
**Installation Guide**
|
||||
|
||||
1. Insight is the default search engine of this site.
|
||||
You can enable it using the following theme configuration
|
||||
You can enable it using the following theme configuration:
|
||||
|
||||
{% codeblock themes/icarus/_config.yml lang:yaml %}
|
||||
search:
|
||||
|
@ -155,6 +177,9 @@ Please refer to it for a complete list of supported plugins and their configurat
|
|||
{% endcodeblock %}
|
||||
|
||||
|
||||
<div class="notification is-warning is-size-6">
|
||||
<article class="message message-immersive is-warning">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-question-circle mr-2"></i>
|
||||
Something wrong with this article? Click <a href="https://github.com/ppoffice/hexo-theme-icarus/edit/site/source/_posts/en/Search-Plugins.md">here</a> to submit your revision.
|
||||
</div>
|
||||
</article>
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
Binary file not shown.
After Width: | Height: | Size: 68 KiB |
Loading…
Reference in New Issue