Descripción general

Puedes usar gtx-cli para traducir automáticamente los archivos Markdown (MD y MDX) de tu proyecto.

Seguiremos estos 4 pasos:

Paso 1: Añade tus variables de entorno

Añade tu clave de API de producción y el id del proyecto a tus variables de entorno. Esto es necesario para usar la CLI gtx-cli. Puedes obtenerlos en el dashboard de General Translation.

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

Paso 2: Instala gtx-cli

Instala la herramienta gtx-cli en tu proyecto.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

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:

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

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

Si tus archivos son MD, puedes usar la clave md en lugar de mdx. El arreglo de cadenas en la clave include debe ser un patrón glob que coincida con todos tus archivos MDX.

Debe usar el marcador [locale] para que coincida con el locale del archivo.

Consulta la documentación de configuration para obtener más información sobre el archivo gt.config.json.

Paso 4: Añade el comando gtx-cli translate a tu proceso de compilación

Añade el comando gtx-cli translate a tu proceso de compilación o a tu CI antes del comando de build para incorporar automáticamente las traducciones a tu proyecto.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <tu comando de build>"
  }
}

Esto generará traducciones para todas tus locales y las guardará en tu proyecto. Si quieres commitear estos files en tu repositorio, en su lugar puedes ejecutar este comando antes de hacer el commit.

¡Listo! Ahora tu proyecto actualizará automáticamente todos tus archivos Markdown cada vez que tu proyecto cambie.

Notas

• Puedes agregar traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
• Si quieres hacer commit de tus archivos de traducción, ejecuta el comando gtx-cli translate antes de confirmar.
• Para configurar la ruta de salida de tus traducciones, consulta la documentación de configuración.

Próximos pasos

• Consulta la guía de uso de la herramienta CLI.