Skip to content

Commit 8980d47

Browse files
authored
fix(website): Fix API Reference docs page formatting (#2783)
1 parent 4e0fc72 commit 8980d47

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

packages/website/docs/api.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,17 @@ in case you want to use different credentials for askAi
241241
</TabItem>
242242
</Tabs>
243243

244-
:::tip Ask AI supports these essential search parameters for optimal performance:
244+
:::tip[Ask AI supports these essential search parameters for optimal performance:]
245245

246246
- **Filtering**: `facetFilters: ['type:content']` - Filter by language, version, or content type
247247
- **Complex filtering**: `filters: 'type:content AND language:en'` - Apply complex filtering rules
248248
- **Content control**: `attributesToRetrieve: ['title', 'content', 'url']` - Control which attributes are retrieved
249249
- **Search scope**: `restrictSearchableAttributes: ['title', 'content']` - Limit search to specific fields
250250
- **Deduplication**: `distinct: true` - Remove duplicate results
251251

252-
These parameters provide the essential functionality for Ask AI while keeping the API simple and focused. :::
252+
These parameters provide the essential functionality for Ask AI while keeping the API simple and focused.
253+
254+
:::
253255

254256
## `searchParameters`
255257

@@ -594,11 +596,13 @@ docsearch({
594596
</TabItem>
595597
</Tabs>
596598

597-
:::info Keyboard Shortcut Behavior
599+
:::info[Keyboard Shortcut Behavior]
598600

599601
- **Ctrl/Cmd+K**: Toggle shortcut that both opens and closes the modal
600602
- **/**: Character shortcut that only opens the modal (prevents interference with search typing)
601-
- **Escape**: Always works to close the modal regardless of configuration :::
603+
- **Escape**: Always works to close the modal regardless of Configuration
604+
605+
:::
602606

603607
## `resultsFooterComponent`
604608

0 commit comments

Comments
 (0)