# gt: General Translation CLI tool: Markdown
URL: https://generaltranslation.com/es/docs/cli/formats/mdx.mdx
---
title: Markdown
description: Cómo usar General Translation para configurar la traducción automática de los archivos Markdown de tu proyecto
---

## Resumen

`gt` puede usarse para traducir automáticamente los archivos Markdown (MD y MDX) de tu proyecto.

<Callout type="info">
  Toda la sintaxis y el formato presentes en los archivos originales se conservarán en
  los archivos traducidos.
</Callout>

Seguiremos estos 4 pasos:

<Steps>
  <Step>
    Agrega tus variables de entorno
  </Step>

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

  <Step>
    Configura el archivo [`gt.config.json`](/docs/cli/reference/config) de tu proyecto
  </Step>

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

***

## Paso 1: Agrega tus variables de entorno

Agrega tu clave API de producción y el ID del proyecto a tus variables de entorno.
Esto es necesario para usar la herramienta `gt`.
Puedes obtenerlos en el [panel de control de General Translation](https://generaltranslation.com/dashboard).

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


## Paso 2: Instala `gt`

Instala la herramienta `gt` en tu proyecto.

<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>

## Paso 3: Configura el archivo `gt.config.json` de tu proyecto

Crea un archivo `gt.config.json` en la raíz de tu proyecto con el siguiente contenido:

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

<Callout type="info">
  Si tus archivos son MD, puedes usar la clave `md` en lugar de `mdx`.
</Callout>

Cambia `defaultLocale` y `locales` para que coincidan con los locales de tu proyecto.

El array de cadenas de la clave `include` debe ser un patrón glob que coincida con todos tus archivos MDX.

Debe usar el marcador de posición `[locale]` para que coincida con la configuración regional del archivo.

Consulta la documentación de [configuración](/docs/cli/reference/config) para obtener más información sobre el archivo `gt.config.json`.


## Paso 4: Agrega el comando `gt translate` a tu proceso de compilación

Agrega el comando `gt translate` a tu proceso de compilación o de CI antes del comando de compilación para añadir traducciones automáticamente a tu proyecto.

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

Esto generará traducciones para todos tus locales y las guardará en tu proyecto.
Si quieres hacer commit de estos archivos en tu repositorio, puedes ejecutar este comando antes de hacer commit.

¡Listo! A partir de ahora, tu proyecto actualizará automáticamente todos tus archivos Markdown cada vez que cambie.

***


## Notas

* Puedes añadir traducciones automáticamente a tu proyecto con el comando [`gt translate`](/docs/cli/translate).
* Si quieres hacer commit de tus archivos de traducción, debes ejecutar el comando `gt translate` antes de hacer commit.
* Para configurar la ruta de salida de tus traducciones, consulta la documentación de [configuración](/docs/cli/reference/config).

## Próximos pasos

* Consulta la [guía de uso](/docs/cli/reference/usage) de la herramienta CLI.