Extraits réutilisables

Créez des extraits de contenu réutilisables avec des variables pour maintenir la cohérence entre les pages de documentation et réduire la duplication dans vos fichiers MDX.

L’un des principes fondamentaux du développement logiciel est DRY (Don’t Repeat Yourself), qui s’applique aussi à la documentation. Si vous vous retrouvez à répéter le même contenu à plusieurs endroits, créez un extrait personnalisé pour ce contenu. Les extraits contiennent du contenu que vous pouvez importer dans d’autres fichiers pour le réutiliser. Vous contrôlez l’endroit où l’extrait apparaît sur une page. Si vous devez un jour mettre à jour ce contenu, il vous suffit de modifier l’extrait plutôt que chaque fichier où l’extrait est utilisé.

​

Fonctionnement des snippets

Les snippets sont des fichiers .mdx, .md ou .jsx importés dans un autre fichier. Vous pouvez placer les fichiers de snippets n’importe où dans votre projet.

Lorsque vous importez un snippet dans un autre fichier, celui-ci n’apparaît qu’à l’endroit où vous l’importez et n’est pas affiché comme une page autonome. Tout fichier dans le dossier /snippets/ est toujours un snippet, même s’il n’est pas importé dans un autre fichier.

​

Créer des snippets

Créez un fichier avec le contenu que vous souhaitez réutiliser. Les snippets peuvent contenir tous les types de contenu pris en charge par Mintlify et peuvent importer d’autres snippets.

​

Importer des snippets dans des pages

Importez des snippets dans des pages en utilisant soit un chemin absolu, soit un chemin relatif.

• Imports absolus : commencez par / pour importer depuis la racine de votre projet.
• Imports relatifs : utilisez ./ ou ../ pour importer des snippets par rapport à l’emplacement du fichier courant.

Les imports relatifs permettent la navigation dans l’IDE. Appuyez sur CMD et cliquez sur le nom d’un snippet dans votre éditeur pour accéder directement à la définition de ce snippet.

​

Importer du texte

1. Ajoutez à votre fichier de snippet le contenu que vous souhaitez réutiliser.

   shared/my-snippet.mdx

   Hello world! This is my content I want to reuse across pages.
   

2. Importez l’extrait dans votre fichier de destination à l’aide d’un chemin absolu ou relatif.

   Import absolu

   ---
   title: "Une page d'exemple"
   description: "Ceci est une page d'exemple qui importe un extrait."
   ---
   
   import MySnippet from "/shared/my-snippet.mdx";
   
   Le contenu de l'extrait s'affiche sous cette phrase.
   
   <MySnippet />
   

​

Importer des variables

Faites référence à des variables issues d’un extrait dans une page.

1. Exportez des variables depuis un fichier de fragment.

   shared/custom-variables.mdx

   export const myName = "Ronan";
   
   export const myObject = { fruit: "strawberries" };
   
   ;
   

2. Importez l’extrait depuis votre fichier de destination et utilisez la variable.

   destination-file.mdx

   ---
   title: "Une page d'exemple"
   description: "Ceci est une page d'exemple qui importe un fragment avec des variables."
   ---
   
   import { myName, myObject } from "/shared/custom-variables.mdx";
   
   Bonjour, je m'appelle {myName} et j'aime {myObject.fruit}.
   

​

Importer des extraits avec des variables

Utilisez des variables pour transmettre des données à un extrait lorsque vous l’importez.

1. Ajoutez des variables à votre extrait et transmettez des propriétés lorsque vous l’importez. Dans cet exemple, la variable est {word}.

   shared/my-snippet.mdx

   Mon mot-clé du jour est {word}.
   

2. Importez l’extrait dans votre fichier de destination en utilisant la variable. La propriété que vous transmettez remplace la variable dans la définition de l’extrait.

   destination-file.mdx

   ---
   title: "Une page d'exemple"
   description: "Ceci est une page d'exemple qui importe un extrait avec une variable."
   ---
   
   import MySnippet from "/shared/my-snippet.mdx";
   
   <MySnippet word="bananas" />
   

​

Importer des composants React

1. Créez un extrait avec un composant JSX. Voir Composants React pour en savoir plus.

   components/my-jsx-snippet.jsx

   export const MyJSXSnippet = () => {
     return (
       <div>
         <h1>Bonjour, monde !</h1>
       </div>
     );
   };
   

Important : lors de la création d’extraits JSX, utilisez la syntaxe de fonction fléchée (=>) plutôt que des déclarations de fonction. Le mot‑clé function n’est pas pris en charge dans les extraits.

2. Importez l’extrait.

   destination-file.mdx

   ---
   title: "Une page d'exemple"
   description: "Ceci est une page d'exemple qui importe un extrait avec un composant React."
   ---
   
   import { MyJSXSnippet } from "/components/my-jsx-snippet.jsx";
   
   <MyJSXSnippet />