Mintlify

Qu'est-ce que Mintlify ?

Mintlify est une plateforme de documentation qui crée des sites de documentation élégants et personnalisables. Elle fournit des fonctionnalités intégrées de recherche, d'analyse et de terrain de jeu API pour construire une documentation moderne pour les développeurs.

Qu'est-ce que Lingo.dev CLI ?

Lingo.dev est une plateforme de traduction alimentée par l'IA. Le CLI de Lingo.dev lit les fichiers source, envoie le contenu traduisible aux modèles de langage avancés, et écrit les fichiers traduits dans votre projet.

À propos de ce guide

Ce guide explique comment configurer le CLI de Lingo.dev dans un site de documentation Mintlify. Vous apprendrez comment structurer un projet avec Mintlify, configurer un pipeline de traduction et visualiser les résultats.

Étape 1. Configurer un projet Mintlify

1. Installez le CLI de Mintlify :

   npm i -g mint
   

2. Clonez le modèle de démarrage Mintlify :

   git clone https://github.com/mintlify/starter.git
   

3. Naviguez dans le répertoire du projet :

   cd starter
   

Étape 2. Créer du contenu source

1. Créez un répertoire pour stocker la documentation dans la locale source :

   mkdir en
   

2. Créez un fichier qui contient du contenu de documentation (par exemple, en/overview.mdx) :

   ---
   title: "Introduction"
   description: "Bienvenue dans le nouveau domicile de votre documentation"
   ---
   
   ## Premiers pas
   
   Cette documentation est automatiquement traduite par Lingo.dev.
   
   ## Fonctionnalités
   
   Notre produit inclut des capacités puissantes pour le développement moderne.
   

Étape 3. Configurer le CLI

À la racine du projet, créez un fichier i18n.json :

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": 1.8,
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

Ce fichier définit :

• les fichiers que Lingo.dev CLI doit traduire
• les langues entre lesquelles traduire

Dans ce cas, la configuration traduit les fichiers MDX de l'anglais vers l'espagnol.

Il est important de noter que :

• [locale] est un placeholder qui est remplacé à l'exécution. Il garantit que le contenu est lu depuis un emplacement (par ex., en/index.mdx) et écrit à un emplacement différent (par ex., es/index.mdx).
• Lingo.dev CLI ne prend pas en charge les modèles glob récursifs (par ex., **/*.mdx). Vous devrez créer des modèles include supplémentaires pour traduire les fichiers qui existent dans des répertoires imbriqués.

Pour en savoir plus, consultez configuration i18n.json.

Étape 4. Traduire le contenu

1. Créez un compte Lingo.dev.

2. Connectez-vous à Lingo.dev via l'interface en ligne de commande :

   npx lingo.dev@latest login
   

3. Exécutez le pipeline de traduction :

   npx lingo.dev@latest run
   

   L'interface en ligne de commande créera un répertoire es/ pour stocker le contenu traduit et un fichier i18n.lock pour suivre ce qui a été traduit (afin d'éviter les retraductions inutiles).

Étape 5. Utiliser les traductions

1. Dans le fichier docs.json, ajoutez une propriété languages à l'objet navigation :

   {
     "navigation": {
       "languages": []
     }
   }
   

2. Pour chaque langue prise en charge, ajoutez un objet distinct au tableau :

   {
     "navigation": {
       "languages": [
         {
           "language": "en",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["en/overview"]
             }
           ]
         },
         {
           "language": "es",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["es/overview"]
             }
           ]
         }
       ]
     }
   }
   

   Notez que :

   • Vous devrez répliquer l'intégralité de la structure de navigation séparément pour chaque langue.
   • Mintlify ne prend en charge qu'un sous-ensemble des langues supportées par Lingo.dev CLI.

3. Démarrez le serveur de développement :

   mint dev
   

4. Naviguez vers http://localhost:3000. Vous devriez voir un menu déroulant permettant de basculer entre les langues.

Limitations connues

• Tout texte d'interface utilisateur défini dans le fichier docs.json (par exemple, les étiquettes de groupe de la barre latérale, le texte d'espace réservé de recherche, etc.) ne sera pas traduit.

Langues prises en charge

Mintlify ne prend en charge qu'un sous-ensemble des langues supportées par Lingo.dev CLI. Pour la liste la plus à jour, consultez la documentation officielle.