Markdown

Aperçu

gtx-cli peut être utilisé pour traduire automatiquement les fichiers Markdown (MD et MDX) de votre projet.

Nous suivrons ces 4 étapes :

Étape 1 : Ajoutez vos variables d'environnement

Ajoutez votre clé API de production et votre ID de projet à vos variables d'environnement. Ceci est nécessaire pour utiliser l'outil gtx-cli. Vous obtenez ces informations depuis le tableau de bord de General Translation.

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

Étape 2 : Installer gtx-cli

Installez l'outil gtx-cli dans votre projet.

npm i --save-dev gtx-cli

Étape 3 : Configurez le fichier gt.config.json de votre projet

Créez un fichier gt.config.json à la racine de votre projet, avec le contenu suivant :

{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "mdx": {
      "include": ["docs/[locale]/**/*.mdx"]
    }
  }
}

Modifiez les valeurs de defaultLocale et locales pour correspondre aux locales de votre projet.

Si vos fichiers sont au format MD, vous pouvez utiliser la clé md au lieu de mdx. Le tableau de chaînes dans la clé include doit être un modèle glob qui correspond à tous vos fichiers MDX.

Il doit utiliser le placeholder [locale] pour correspondre à la locale du fichier.

Consultez la documentation de configuration pour plus d'informations sur le fichier gt.config.json.

Étape 4 : Ajouter la commande gtx-cli translate à votre processus de build

Ajoutez la commande gtx-cli translate à votre processus de build ou CI avant la commande de build pour ajouter automatiquement des traductions à votre projet.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

Cela générera des traductions pour toutes vos locales et les enregistrera dans votre projet. Si vous souhaitez valider ces fichiers dans votre dépôt, vous pouvez exécuter cette commande avant de faire un commit.

C'est terminé ! Maintenant, votre projet mettra automatiquement à jour tous vos fichiers Markdown chaque fois que votre projet change.

Notes

• Vous pouvez ajouter automatiquement des traductions à votre projet avec la commande gtx-cli translate.
• Si vous souhaitez valider vos fichiers de traduction, vous devriez exécuter la commande gtx-cli translate avant de les valider.
• Pour configurer le chemin de sortie de vos traductions, consultez la documentation de configuration.

Prochaines étapes

• Consultez le guide d'utilisation pour l'outil cli.