页头 DocSearch 模块
赞助
成为我们的资助者或赞助商，以支持我们的工作。
本页内容
赞助商
DocSearch 是一个线上搜索引擎，其为开源文档站点提供免费服务。
| 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. |
你需要申请并等待批准。
站点参数
一旦申请通过，你将会收到一封邮件，其中包含了设置 DocSearch 模块的必要信息。
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
api_key | string | Y | - | API 秘钥。 |
app_id | string | Y | - | 应用名称。 |
debug | boolean | - | - | 是否开启调试模式。 |
index_name | string | Y | - | 索引名称。 |
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}
