type | aliases | title | linkTitle | date | draft | nav_icon | series | categories | tags | images | authors | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
docs |
|
Header DocSearch Module |
DocSearch |
2023-04-21 01:52:36 +0800 |
false |
|
|
|
|
|
DocSearch is a free online search service for open source documentation sites.
{{% hb-module "header/modules/docsearch" %}}
You need to apply and waiting for approval.
Once your request was approved, you'll be emailed with the necessary information to set up the DocSearch module.
Name | Type | Required | Default | Description |
---|---|---|---|---|
api_key |
string | Y | - | The API key. |
app_id |
string | Y | - | The App name. |
debug |
boolean | - | - | Whether to enable debug mode. |
index_name |
string | Y | - | The index name. |
{{% bs/config-toggle params %}} {{% code-snippet params.yaml %}} {{% /bs/config-toggle %}}