Markdown

Descripción general

gtx-cli puede utilizarse 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 API de producción y el ID del proyecto a tus variables de entorno. Esto es necesario para usar la herramienta gtx-cli. Puedes obtener estos datos desde el panel de control de General Translation.

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

Paso 2: Instalar gtx-cli

Instala la herramienta gtx-cli en tu proyecto.

npm i --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 el defaultLocale y locales para que coincidan con los idiomas de tu proyecto.

Si tus archivos son archivos MD, puedes usar la clave md en lugar de mdx. El array de strings en 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 coincidir con el idioma del archivo.

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

Paso 4: Añadir 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 compilación para agregar automáticamente traducciones a tu proyecto.

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

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

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

Notas

• Puedes añadir traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
• Si quieres confirmar tus archivos de traducción, deberías 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 para la herramienta cli.