Panoramica

gtx-cli può essere utilizzato per tradurre automaticamente i file Markdown (MD e MDX) del tuo progetto.

Seguiremo questi 4 passaggi:

Passaggio 1: Aggiungi le variabili d’ambiente

Aggiungi la tua chiave API di produzione e l’ID del progetto alle variabili d’ambiente. Questo è necessario per utilizzare lo strumento gtx-cli. Puoi ottenerli dalla dashboard di General Translation.

GT_API_KEY=<la-tua-API-key>
GT_PROJECT_ID=<il-tuo-ID-progetto>

Passaggio 2: installa gtx-cli

Installa lo strumento gtx-cli nel tuo progetto.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Passaggio 3: configura il file gt.config.json del progetto

Crea un file gt.config.json nella root del progetto con il seguente contenuto:

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

Modifica defaultLocale e locales in modo che corrispondano alle impostazioni locali del tuo progetto.

Se i tuoi file sono MD, puoi usare la chiave md invece di mdx. L’array di stringhe nella chiave include dovrebbe essere un pattern glob che corrisponda a tutti i tuoi file MDX.

Dovrebbe usare il segnaposto [locale] per far corrispondere la lingua/locale del file.

Consulta la documentazione sulla configurazione per ulteriori informazioni sul file gt.config.json.

Passaggio 4: aggiungi il comando gtx-cli translate al processo di build

Aggiungi il comando gtx-cli translate al processo di build o di CI prima del comando di build per aggiungere automaticamente le traduzioni al progetto.

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

Questo genererà le traduzioni per tutte le tue locale e le salverà nel progetto. Se vuoi eseguire il commit di questi file nel tuo repo, puoi eseguire questo comando prima di confermare.

Tutto fatto! D’ora in poi il progetto aggiornerà automaticamente tutti i file Markdown ogni volta che il progetto cambia.

Note

• Puoi aggiungere automaticamente le traduzioni al tuo progetto con il comando gtx-cli translate.
• Se vuoi includere i file di traduzione nel commit, esegui il comando gtx-cli translate prima di effettuare il commit.
• Per configurare il percorso di output delle traduzioni, consulta la documentazione di configurazione.

Prossimi passaggi

• Consulta la guida all’utilizzo dello strumento CLI.