Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

export const WidgetCodeBlock = ({ children, ...props }) => (
<CodeBlock {...props}>{children}</CodeBlock>
);

Check warning on line 13 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L13

Use semicolons judiciously.

The [assistant](/assistant) answers questions on your Mintlify site. To embed the same capability on another site or web app, use the widget. The widget gives your users access to AI chat trained on your content, wherever they use your product. Embed it in your dashboard, marketing site, support portal, or elsewhere.

Expand Down Expand Up @@ -180,6 +180,7 @@
| `starterQuestions` | string[] | Sets up to three empty-state prompts for this embed. |
| `filter` | [`AssistantFilter`](#assistantfilter) | Restricts retrieval to a docs language and version. |
| `hooks` | [`AssistantHooks`](#assistanthooks) | Event and error observers. |
| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Internal widget analytics settings. |

### `AssistantAppearance`

Expand All @@ -205,6 +206,12 @@
| `language` | string or `null` | Restricts retrieval to a [supported language code](/organize/settings-reference#navigation-global-languages), such as `en`. Omit to search all languages. |
| `version` | string or `null` | Restricts retrieval to a docs version, such as `v2`. Omit to search all versions. |

### `AssistantAnalyticsConfig`

| Option | Type | Description |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `capturePathname` | boolean | Includes the embedding page's current pathname in internal widget analytics events. The default is `true`. Set to `false` to opt out. |

### `AssistantLabels`

| Option | Values | Description |
Expand Down Expand Up @@ -279,7 +286,7 @@

Conversation snapshots remain private to the widget. Each method resolves to `void`.

## Content Security Policy

Check warning on line 289 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L289

'Content Security Policy' should use sentence-style capitalization.

If your site uses a Content Security Policy, allow the origins required by your enabled widget features:

Expand All @@ -290,9 +297,9 @@
| `connect-src` | `https://api.mintlify.com` | Configuration, messages, and feedback |
| `connect-src` | `https://ph.mintlify.com` | Internal widget analytics |
| `font-src` | `https://widget.mintlify.com` | Optional bundled Inter font |
| `script-src`, `connect-src`, and `frame-src` | `https://challenges.cloudflare.com` | Turnstile bot protection |

Check warning on line 300 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L300

Use 'Cloudflare' instead of 'cloudflare'.
| `script-src` | `https://js.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 301 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L301

Use 'hCaptcha' instead of 'hcaptcha'.
| `connect-src` and `frame-src` | `https://*.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 302 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L302

Use 'hCaptcha' instead of 'hcaptcha'.

A strict `script-src` policy must still authorize both the loader and initialization script. A strict `style-src` policy must authorize the nonce you pass to `init()`, which the widget copies to its injected style sheet. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization.

Expand Down
9 changes: 9 additions & 0 deletions es/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ Pasa este objeto a `init()`.
| `starterQuestions` | string[] | Establece hasta **tres** sugerencias de estado vacío para este embed. |
| `filter` | [`AssistantFilter`](#assistantfilter) | Restringe la recuperación a un idioma y versión de la documentación. |
| `hooks` | [`AssistantHooks`](#assistanthooks) | Observadores de eventos y errores. |
| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Configuración de la analítica interna del widget. |

<div id="assistantappearance">
### `AssistantAppearance`
Expand Down Expand Up @@ -227,6 +228,14 @@ No se admiten sobrescrituras arbitrarias de CSS ni de paleta neutra. El Shadow D
| `language` | string or `null` | Restringe la recuperación a un [código de idioma admitido](/es/organize/settings-reference#navigation-global-languages), como `en`. Omítelo para buscar en todos los idiomas. |
| `version` | string or `null` | Restringe la recuperación a una versión de la documentación, como `v2`. Omítela para buscar en todas las versiones. |

<div id="assistantanalyticsconfig">
### `AssistantAnalyticsConfig`
</div>

| Option | Type | Description |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `capturePathname` | boolean | Incluye la ruta actual de la página que incrusta el widget en los eventos internos de analítica. El valor por defecto es `true`. Establécelo en `false` para desactivarlo. |

<div id="assistantlabels">
### `AssistantLabels`
</div>
Expand Down
9 changes: 9 additions & 0 deletions fr/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ Passez cet objet à `init()`.
| `starterQuestions` | string[] | Définit jusqu'à **trois** invites d'état vide pour cette intégration. |
| `filter` | [`AssistantFilter`](#assistantfilter) | Restreint la recherche à une langue et à une version de la documentation. |
| `hooks` | [`AssistantHooks`](#assistanthooks) | Observateurs d'événements et d'erreurs. |
| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Paramètres des analyses internes du widget. |

<div id="assistantappearance">
### `AssistantAppearance`
Expand Down Expand Up @@ -227,6 +228,14 @@ Les substitutions CSS arbitraires et les palettes neutres ne sont pas prises en
| `language` | string or `null` | Restreint la recherche à un [code de langue pris en charge](/fr/organize/settings-reference#navigation-global-languages), tel que `en`. Omettez pour rechercher dans toutes les langues. |
| `version` | string or `null` | Restreint la recherche à une version de la documentation, telle que `v2`. Omettez pour rechercher dans toutes les versions. |

<div id="assistantanalyticsconfig">
### `AssistantAnalyticsConfig`
</div>

| Option | Type | Description |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `capturePathname` | boolean | Inclut le chemin actuel de la page qui intègre le widget dans les événements d'analyse internes. La valeur par défaut est `true`. Définissez-le sur `false` pour ne pas participer. |

<div id="assistantlabels">
### `AssistantLabels`
</div>
Expand Down
9 changes: 9 additions & 0 deletions zh/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ await window.MintlifyAssistant.update({
| `starterQuestions` | string[] | 为该嵌入设置最多 **三** 条空状态提示。 |
| `filter` | [`AssistantFilter`](#assistantfilter) | 将检索限定到指定的文档语言和版本。 |
| `hooks` | [`AssistantHooks`](#assistanthooks) | 事件和错误观察者。 |
| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | 内部小组件分析设置。 |

<div id="assistantappearance">
### `AssistantAppearance`
Expand Down Expand Up @@ -227,6 +228,14 @@ await window.MintlifyAssistant.update({
| `language` | string or `null` | 将检索限定到[受支持的语言代码](/zh/organize/settings-reference#navigation-global-languages),例如 `en`。省略以在所有语言中检索。 |
| `version` | string or `null` | 将检索限定到指定的文档版本,例如 `v2`。省略以在所有版本中检索。 |

<div id="assistantanalyticsconfig">
### `AssistantAnalyticsConfig`
</div>

| Option | Type | Description |
| ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `capturePathname` | boolean | 在内部小组件分析事件中包含嵌入页面的当前路径。默认值为 `true`。设置为 `false` 可选择停用。 |

<div id="assistantlabels">
### `AssistantLabels`
</div>
Expand Down