Descripción general

gtx-cli se puede usar para traducir automáticamente los files 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 CLI 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 files son archivos MD, puedes usar la clave md en lugar de mdx. La matriz de strings en la clave include debe ser un patrón glob que coincida con todos tus files MDX.

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

Consulta la documentación de configuration para obtener más información sobre el file 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 CI, antes del comando de build, para añadir 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 todos tus locales y las guardará en tu proyecto. Si quieres confirmar estos files en tu repo, puedes ejecutar este comando antes de confirmar.

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

Notas

• Puedes agregar traducciones a tu proyecto automáticamente con el comando gtx-cli translate.
• Si quieres confirmar tus archivos de traducción, debes ejecutar 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.