頁頭 DocSearch 模塊

2023年4月21日 1 分鐘閱讀模塊文檔搜索 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}