mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
ade1fbbd39
* docs: address reader-question gaps in recently updated pages * docs: shorten analytics description, split long sentence, mirror translations --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
223 lines
11 KiB
Plaintext
223 lines
11 KiB
Plaintext
---
|
||
title: "Menu contextuel"
|
||
description: "Ajoutez à votre documentation un menu contextuel avec des intégrations d'IA en un clic pour ChatGPT, Claude, Perplexity, Google AI Studio et les outils MCP."
|
||
keywords: ["Outils d'IA", "ChatGPT", "Claude", "Perplexity", "MCP", "Grok", "cursor", "vscode", "vs code", "Google AI Studio", "aistudio", "Devin", "Windsurf", "Devin Desktop", "pdf", "copier la page", "bouton copier", "copier le markdown", "copier en markdown", "afficher en markdown", "menu contextuel", "menu de page", "menu IA", "actions IA", "ouvrir dans", "télécharger pdf", "exporter pdf", "demander à l'IA", "openapi", "télécharger la spec"]
|
||
---
|
||
|
||
import { PreviewButton } from "/snippets/previewbutton.jsx"
|
||
import IconsRequired from "/snippets/fr/icons-required.mdx";
|
||
|
||
Le menu contextuel offre un accès rapide à un objet optimisé par l’IA et à des intégrations directes avec des outils d’IA populaires. Lorsque les utilisateurs ouvrent le menu contextuel sur n’importe quelle page, ils peuvent copier l’objet comme context pour des outils d’IA ou lancer des conversations dans ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Devin Desktop, ou un outil personnalisé de votre choix, avec votre documentation déjà chargée comme context.
|
||
|
||
<Tip>
|
||
Associez le menu contextuel à votre fichier [`skill.md`](/fr/ai/skillmd) hébergé et à votre [serveur MCP](/fr/ai/model-context-protocol) afin que vos utilisateurs puissent installer dans leurs outils d’IA toutes les capacités de votre produit, et pas seulement la page qu’ils consultent.
|
||
</Tip>
|
||
|
||
<div id="menu-options">
|
||
## Options du menu
|
||
</div>
|
||
|
||
Le menu contextuel comprend plusieurs options prédéfinies que vous pouvez activer en ajoutant leur identifiant à votre configuration.
|
||
|
||
| Option | Identifiant | Description |
|
||
| :---------------------------------------- | :----------- | :------------------------------------------------------------------------------------ |
|
||
| **Copier la page** | `copy` | Copie la page actuelle en Markdown pour la coller comme contexte dans des outils d’IA |
|
||
| **Afficher en Markdown** | `view` | Ouvre la page actuelle en Markdown |
|
||
| **Demander à l’Assistant** | `assistant` | Ouvre l’[Assistant](/fr/assistant/index) avec la page actuelle comme contexte |
|
||
| **Télécharger le PDF** | `download-pdf` | Télécharge la page actuelle au format PDF. Disponible avec les [offres Enterprise](https://mintlify.com/pricing). |
|
||
| **Ouvrir dans ChatGPT** | `chatgpt` | Crée une conversation ChatGPT avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Claude** | `claude` | Crée une conversation Claude avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Perplexity** | `perplexity` | Crée une conversation Perplexity avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Grok** | `grok` | Crée une conversation Grok avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Google AI Studio** | `aistudio` | Crée une conversation Google AI Studio avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Devin** | `devin` | Crée une session Devin avec la page actuelle comme contexte |
|
||
| **Ouvrir dans Devin Desktop** | `devin-desktop` | Ouvre Devin Desktop avec la page actuelle comme contexte. Nécessite l'installation de Devin Desktop. |
|
||
| **Copier l’URL du serveur MCP** | `mcp` | Copie l’URL de votre serveur MCP dans le presse‑papiers |
|
||
| **Copier la commande d’installation MCP** | `add-mcp` | Copie la commande `npx add-mcp` pour installer le serveur MCP |
|
||
| **Se connecter à Cursor** | `cursor` | Installe votre serveur MCP hébergé dans Cursor |
|
||
| **Se connecter à VS Code** | `vscode` | Installe votre serveur MCP hébergé dans VS Code |
|
||
| **Se connecter à Devin** | `devin-mcp` | Installe votre serveur MCP hébergé dans Devin |
|
||
| **Télécharger la spécification d'API** | `downloadApiSpec` | Télécharge la spécification OpenAPI de votre déploiement. Si plusieurs spécifications sont configurées, les télécharge dans une archive zip. N'apparaît que sur les pages de référence d'API. |
|
||
| **Options personnalisées** | Objet | Ajoutez des options personnalisées au menu contextuel |
|
||
|
||
<Frame>
|
||
<img src="/images/contextual-menu/contextual-menu.png" alt="Le menu contextuel développé affichant les éléments Copier la page, Afficher en Markdown, Ouvrir dans ChatGPT et Ouvrir dans Claude." />
|
||
</Frame>
|
||
|
||
<Note>
|
||
L'option `downloadApiSpec` n'apparaît que sur les pages de référence d'API (pages dont le frontmatter déclare `api`, `openapi` ou `asyncapi`). Sur les déploiements avec authentification ou authentification utilisateur activée, seuls les lecteurs authentifiés peuvent télécharger la spécification.
|
||
</Note>
|
||
|
||
<div id="enabling-the-contextual-menu">
|
||
## Activer le menu contextuel
|
||
</div>
|
||
|
||
Ajoutez le champ `contextual` à votre fichier `docs.json` et indiquez les options que vous souhaitez inclure. Les options apparaissent dans le menu dans l'ordre où vous les listez.
|
||
|
||
```json
|
||
{
|
||
"contextual": {
|
||
"options": [
|
||
"copy",
|
||
"view",
|
||
"assistant",
|
||
"download-pdf",
|
||
"chatgpt",
|
||
"claude",
|
||
"perplexity",
|
||
"grok",
|
||
"aistudio",
|
||
"devin",
|
||
"devin-desktop",
|
||
"mcp",
|
||
"cursor",
|
||
"vscode",
|
||
"devin-mcp",
|
||
"downloadApiSpec"
|
||
]
|
||
}
|
||
}
|
||
```
|
||
|
||
<div id="display-location">
|
||
## Emplacement d’affichage
|
||
</div>
|
||
|
||
Par défaut, le menu contextuel apparaît dans l’en-tête de la page. Vous pouvez le configurer pour qu’il s’affiche à la place dans la barre latérale de la table des matières à l’aide de l’option `display`.
|
||
|
||
```json
|
||
{
|
||
"contextual": {
|
||
"options": ["copy", "view", "chatgpt", "claude"],
|
||
"display": "toc"
|
||
}
|
||
}
|
||
```
|
||
|
||
| Valeur | Description |
|
||
| :------- | :-------------------------------------------------------------------------- |
|
||
| `header` | Affiche les options dans le menu contextuel en haut de la page (par défaut) |
|
||
| `toc` | Affiche les options dans la barre latérale de la table des matières |
|
||
|
||
<div id="adding-custom-options">
|
||
## Ajout d’options personnalisées
|
||
</div>
|
||
|
||
Créez des options personnalisées dans le menu contextuel en ajoutant un objet au tableau `options`. Chaque option personnalisée requiert les propriétés suivantes :
|
||
|
||
<ResponseField name="title" type="string" required>
|
||
Le titre de l’option.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="description" type="string" required>
|
||
La description de l’option. Affichée sous le titre lorsque le menu contextuel se déroule.
|
||
</ResponseField>
|
||
|
||
<IconsRequired />
|
||
|
||
<ResponseField name="href" type="string | object" required>
|
||
Le href de l’option. Utilisez une chaîne pour des liens simples ou un objet pour des liens dynamiques avec des paramètres de requête.
|
||
|
||
<Expandable title="href object">
|
||
<ResponseField name="base" type="string" required>
|
||
L’URL de base de l’option.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="query" type="object" required>
|
||
Les paramètres de requête de l’option.
|
||
|
||
<Expandable title="query object">
|
||
<ResponseField name="key" type="string" required>
|
||
La key du paramètre de requête.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="value" type="string" required>
|
||
La valeur du paramètre de requête. Mintlify remplace les espaces réservés suivants par les valeurs correspondantes :
|
||
|
||
* Utilisez `$page` pour insérer le contenu de la page actuelle en Markdown.
|
||
* Utilisez `$path` pour insérer le chemin de la page actuelle.
|
||
* Utilisez `$mcp` pour insérer l’URL du serveur MCP hébergé.
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField>
|
||
|
||
Exemple d’option personnalisée :
|
||
|
||
```json {9-14} wrap
|
||
{
|
||
"contextual": {
|
||
"options": [
|
||
"copy",
|
||
"view",
|
||
"chatgpt",
|
||
"claude",
|
||
"perplexity",
|
||
{
|
||
"title": "Demander une fonctionnalité",
|
||
"description": "Rejoignez la discussion sur GitHub pour demander une nouvelle fonctionnalité",
|
||
"icon": "plus",
|
||
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
```
|
||
|
||
<div id="override-on-individual-pages">
|
||
## Remplacer sur une page individuelle
|
||
</div>
|
||
|
||
Remplacez le menu contextuel global sur une page spécifique en ajoutant un champ `contextual` au frontmatter de la page. Utilisez cette approche pour mettre en avant des actions propres à la page, comme `download-pdf` sur une page de conditions d’utilisation, ou pour masquer entièrement le menu sur une page d’accueil.
|
||
|
||
L’objet `contextual` au niveau de la page remplace celui défini globalement pour cette page. Omettez le champ pour hériter de `docs.json`, ou définissez `options: []` pour désactiver le menu contextuel sur cette page.
|
||
|
||
```mdx
|
||
---
|
||
title: "Conditions d'utilisation"
|
||
contextual:
|
||
options:
|
||
- copy
|
||
- download-pdf
|
||
display: header
|
||
---
|
||
```
|
||
|
||
Les mêmes champs et règles de validation s’appliquent que dans `docs.json`, y compris les [options personnalisées](#adding-custom-options) et le paramètre `display`. Si un remplacement au niveau d’une page est invalide, Mintlify revient à la configuration `contextual` globale.
|
||
|
||
<div id="custom-option-examples">
|
||
### Exemples d’options personnalisées
|
||
</div>
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="Lien simple">
|
||
```json
|
||
{
|
||
"title": "Demander une fonctionnalité",
|
||
"description": "Rejoindre la discussion sur GitHub",
|
||
"icon": "plus",
|
||
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
|
||
}
|
||
```
|
||
</Accordion>
|
||
|
||
<Accordion title="Lien dynamique avec le contenu de la page">
|
||
```json
|
||
{
|
||
"title": "Partager sur X",
|
||
"description": "Partager cette page sur X",
|
||
"icon": "x",
|
||
"href": {
|
||
"base": "https://x.com/intent/tweet",
|
||
"query": [
|
||
{
|
||
"key": "text",
|
||
"value": "Découvrez cette documentation : $page"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
```
|
||
</Accordion>
|
||
</AccordionGroup> |