Header DocSearch Module

April 21, 2023 1 min read Module Docs Search DocSearch

On this page

Donate

DocSearch is a free online search service for open source documentation sites.

Module	`github.com/hbstack/header/modules/docsearch`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

You need to apply and waiting for approval.

Site Parameters

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.

params.toml

1[docsearch]
2  api_key = 'API_KEY'
3  app_id = 'APP_ID'
4  debug = false
5  index_name = 'INDEX_NAME'

params.yaml

1docsearch:
2  api_key: API_KEY
3  app_id: APP_ID
4  debug: false
5  index_name: INDEX_NAME

params.json

1{
2   "docsearch": {
3      "api_key": "API_KEY",
4      "app_id": "APP_ID",
5      "debug": false,
6      "index_name": "INDEX_NAME"
7   }
8}