Skip to content

Commit 4f1f3d2

Browse files
committed
fix: docs
1 parent 0934664 commit 4f1f3d2

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

packages/website/docs/api.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,11 @@ const translations: DocSearchTranslations = {
173173

174174
## `reportMissingResultsUrl`
175175

176-
> `type: string` | **optional**
176+
> `type: ({ query:string }) => string` | **optional**
177+
178+
> example: ({ query }) => `https://github.com/algolia/docsearch/issues/new?title=${query}`
177179
178-
URL of your documentation repository.
180+
Function to return the URL of your documentation repository.
179181

180182
When provided, an informative message wrapped with your link will be displayed on no results searches. The default text can be changed using the [translations](#translations) property.
181183

@@ -327,9 +329,9 @@ const translations: DocSearchTranslations = {
327329

328330
## `reportMissingResultsUrl`
329331

330-
> `type: string` | **optional**
332+
> example: ({ query }) => `https://github.com/algolia/docsearch/issues/new?title=${query}`
331333
332-
URL of your documentation repository.
334+
Function to return the URL of your documentation repository.
333335

334336
When provided, an informative message wrapped with your link will be displayed on no results searches. The default text can be changed using the [translations](#translations) property.
335337

0 commit comments

Comments
 (0)