# gt: General Translation CLI tool: Markdown
URL: https://generaltranslation.com/it/docs/cli/formats/mdx.mdx
---
title: Markdown
description: Come usare General Translation per configurare la traduzione automatica dei file Markdown del progetto
---

## Panoramica

`gt` può essere utilizzato per tradurre automaticamente i file Markdown (MD e MDX) del progetto.

<Callout type="info">
  Tutta la sintassi e la formattazione presenti nei file originali saranno
  mantenute nei file tradotti.
</Callout>

Seguiremo questi 4 passaggi:

<Steps>
  <Step>
    Aggiungi le variabili d&#39;ambiente
  </Step>

  <Step>
    Installa [`gt`](/docs/cli)
  </Step>

  <Step>
    Configura il file [`gt.config.json`](/docs/cli/reference/config) del progetto
  </Step>

  <Step>
    Esegui [`gt translate`](/docs/cli/translate#translate)
  </Step>
</Steps>

***

## Passo 1: aggiungi le variabili d&#39;ambiente

Aggiungi la chiave API di produzione e l&#39;ID progetto alle variabili d&#39;ambiente.
Questo è necessario per usare lo strumento `gt`.
Puoi recuperarli dalla [dashboard di General Translation](https://generaltranslation.com/dashboard).

```bash title=".env"
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>
```


## Passaggio 2: Installa `gt`

Installa lo strumento `gt` nel progetto.

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm i gt
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

## Passaggio 3: Configura il file `gt.config.json` del progetto

Crea un file `gt.config.json` nella directory principale del progetto con il seguente contenuto:

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "mdx": {
      "include": ["docs/[locale]/**/*.mdx"]
    }
  }
}
```

<Callout type="info">
  Se i tuoi file sono in formato MD, puoi usare la chiave `md` invece di `mdx`.
</Callout>

Modifica `defaultLocale` e `locales` in base alle impostazioni regionali del tuo progetto.

L&#39;array di stringhe nella chiave `include` deve contenere un pattern glob che corrisponda a tutti i file MDX del progetto.

Deve usare il segnaposto `[locale]` per corrispondere all&#39;impostazione regionale del file.

Per maggiori informazioni sul file `gt.config.json`, consulta la documentazione sulla [configurazione](/docs/cli/reference/config).


## Passaggio 4: aggiungi il comando `gt translate` al processo di build

Aggiungi il comando `gt translate` al processo di build o CI prima del comando di build, in modo da aggiungere automaticamente le traduzioni al progetto.

```json title="package.json"
{
  "scripts": {
    "translate": "npx gt translate",
    "build": "npm run translate && <your build command>"
  }
}
```

Questo genererà le traduzioni per tutte le impostazioni regionali del tuo progetto e le salverà nel progetto.
Se vuoi includere questi file nel repository, puoi invece eseguire questo comando prima di effettuare il commit.

Hai finito! Ora il tuo progetto aggiornerà automaticamente tutti i file Markdown ogni volta che apporti modifiche al progetto.

***


## Note

* Puoi aggiungere automaticamente le traduzioni al tuo progetto con il comando [`gt translate`](/docs/cli/translate).
* Se vuoi includere i file di traduzione nel commit, esegui il comando `gt translate` prima di eseguire il commit.
* Per configurare il percorso di output delle traduzioni, consulta la documentazione sulla [configurazione](/docs/cli/reference/config).

## Passaggi successivi

* Consulta il [comando translate](/docs/cli/translate) per i dettagli di utilizzo della CLI.