Saltar al contenido principal
La internacionalización (i18n) es el proceso de diseñar software o contenido para que funcione en distintos idiomas y configuraciones regionales. Esta guía explica cómo estructurar archivos, configurar la navegación y mantener las traducciones de forma eficiente, para que puedas ayudar a los usuarios a acceder a tu documentación en su idioma preferido y mejorar tu alcance global.

Estructura de archivos

Organiza el contenido traducido en directorios específicos por idioma para mantener tu documentación manejable y estructurar tu navigation por idioma. Crea un directorio separado para cada idioma usando los códigos de idioma ISO 639-1. Coloca los archivos traducidos en estos directorios con la misma estructura que tu idioma predeterminado.
Example file structure
Mantén los mismos nombres de archivo y la misma estructura de directorios en todos los idiomas. Esto facilita el mantenimiento de las traducciones y la identificación del contenido faltante.

Configurar el selector de idioma

Para añadir un selector de idioma a tu documentación, configura el array languages en la propiedad navigation de tu docs.json.
docs.json
Cada entrada de idioma en el array languages requiere:
  • language: código de idioma ISO 639-1
  • Estructura completa de navigation
  • Rutas de los archivos traducidos
La estructura de navigation puede diferir entre idiomas para adaptarse a las necesidades de contenido específicas de cada idioma.
No utilices la misma ruta de página en más de una locale. Duplicar rutas entre locales produce un comportamiento indefinido. Cada ruta de página debe aparecer únicamente en la navegación de un solo idioma.

Establecer el idioma predeterminado

El primer idioma del arreglo languages se usa automáticamente como idioma predeterminado. Para establecer otro idioma como predeterminado, reordena el arreglo o agrega la propiedad default:
docs.json
Alternativamente, usa la propiedad default para modificar el orden:
docs.json

Documentación en un solo idioma

Si solo quieres tener un único idioma disponible sin un selector de idioma, elimina el campo languages de tu configuración de navigation. En su lugar, define directamente tu estructura de navigation:
docs.json
Esto muestra la documentación en un solo idioma sin la interfaz de usuario del selector de idioma.
Traduce las etiquetas de navegación, como los nombres de grupos o Tabs, para que coincidan con el idioma del contenido. Esto crea una experiencia completamente localizada para tus usuarios.
Para añadir elementos de navegación global que aparezcan en todos los idiomas, configura el objeto global dentro de la navigation de tu docs.json.
docs.json
Personaliza el pie de página y la barra de navegación de cada idioma para mostrar contenido traducido y enlaces específicos de cada región. Añade las propiedades footer y navbar a la configuración de cada idioma:
docs.json
El footer y el navbar específicos para un idioma reemplazan la configuración global de ese idioma. Si un idioma no define estas propiedades, hereda la configuración global. También puedes configurar un banner específico para un idioma siguiendo el mismo patrón.

Mantén las traducciones

Mantén las traducciones precisas y sincronizadas con tu contenido original.

Flujo de trabajo de traducción

  1. Actualiza el contenido original en tu idioma principal.
  2. Identifica el contenido modificado.
  3. Traduce el contenido modificado.
  4. Revisa las traducciones para comprobar su precisión.
  5. Actualiza los archivos traducidos.
  6. Verifica que la navegación y los enlaces funcionen.

Traducciones automatizadas

Para soluciones de traducción automática, configura una automatización para ejecutar el agente de forma programada o en respuesta a cambios enviados al repositorio.

Proveedores de traducción externos

Si trabajas con tus propios proveedores de traducción o traductores regionales, puedes integrar su flujo de trabajo con tu documentación de Mintlify mediante GitHub Actions o herramientas de CI/CD similares.
  1. Exportar el contenido fuente: Extrae los archivos MDX que necesiten traducción.
  2. Enviar a los traductores: Proporciona los archivos a tu proveedor de traducción.
  3. Recibir las traducciones: Recibe de vuelta los archivos MDX traducidos.
  4. Importar y desplegar: Añade los archivos traducidos a los directorios de idioma y actualiza la navegación.
Este flujo de trabajo de GitHub Actions exporta automáticamente el contenido en inglés modificado para su traducción cuando los PR se fusionan en main.
.github/workflows/export-for-translation.yml
Este flujo de trabajo de GitHub Actions valida e importa el contenido traducido cuando se añade en una PR.
.github/workflows/import-translations.yml
Mejores prácticas para flujos de trabajo de traducción externos
  • Conserva el frontmatter: Asegúrate de que los traductores mantengan intacto el frontmatter en YAML y traduzcan solo los valores de title y description.
  • Protege los bloques de código: Marca los bloques de código como “no traducir” para tus proveedores de traducción.
  • Usa memoria de traducción: Proporciona glosarios con términos técnicos que deban mantenerse en inglés o tener traducciones específicas.
  • Automatiza la validación: Usa comprobaciones de CI para verificar la sintaxis de MDX y el frontmatter antes de integrar las traducciones.
  • Control de versiones: Lleva un seguimiento de la versión de origen de cada traducción para identificar contenido desactualizado.

Imágenes y recursos multimedia

Guarda las imágenes traducidas en directorios específicos para cada idioma.
Referencia las imágenes usando rutas relativas en tu contenido traducido.
es/index.mdx

SEO para sitios multilingües

Optimiza cada versión en cada idioma para los motores de búsqueda.

Metadata de la página

Incluye la metadata traducida en el frontmatter de cada archivo:
fr/index.mdx

Mejores prácticas

Formatos de fecha y número

Ten en cuenta los formatos específicos de cada región para fechas y números.
  • Formatos de fecha: MM/DD/YYYY (mes/día/año) vs DD/MM/YYYY (día/mes/año)
  • Formatos numéricos: 1,000.00 vs 1.000,00
  • Símbolos de moneda: $100.00 vs 100,00€
Incluye ejemplos en el formato apropiado para cada idioma o utiliza formatos universalmente comprensibles.

Mantén la consistencia

  • Mantén el mismo contenido en todos los idiomas para garantizar que cada usuario reciba la misma calidad de información.
  • Crea un glosario de traducción para los términos técnicos.
  • Conserva la misma estructura de contenido en todos los idiomas.
  • Haz que el tono y el estilo coincidan con los de tu contenido original.
  • Usa branches de Git para gestionar el trabajo de traducción por separado de las actualizaciones del contenido principal.

Diferencias de diseño

Algunos idiomas requieren más o menos espacio que el inglés. Prueba tu contenido traducido en diferentes tamaños de pantalla para asegurarte de que:
  • La navegación quepa correctamente.
  • Los bloques de código no se desborden.
  • Las tablas y otros textos con formato sigan siendo legibles.
  • Las imágenes se escalen adecuadamente.

Codificación de caracteres

Asegúrate de que tanto tu entorno de desarrollo como tu pipeline de implementación sean compatibles con la codificación UTF-8 para mostrar correctamente todos los caracteres de idiomas con alfabetos distintos y caracteres especiales.

Preguntas frecuentes

No. Puedes lanzar un idioma con cobertura parcial y expandirlo con el tiempo. Un enfoque común es traducir primero las páginas más visitadas —generalmente el contenido de inicio, autenticación y las guías prácticas principales— y dejar el contenido de referencia de menor tráfico en el idioma predeterminado hasta que las traducciones estén listas. Los usuarios generalmente prefieren algo de contenido traducido a ninguno.
Si un usuario navega a una URL traducida que no existe, verá un error 404. Para evitar esto, incluye solo las páginas traducidas en la navegación específica del idioma o mantén la paridad entre tu idioma predeterminado y el contenido traducido. Usar la misma estructura de archivos en todos los idiomas facilita la identificación de las traducciones faltantes.
Sí. Las etiquetas de navegación —nombres de grupos, títulos de pestañas, texto de ancla— deben coincidir con el idioma del contenido. Una etiqueta “Getting started” en inglés dentro de una sección de documentación en español crea una experiencia discordante. Mintlify admite estructuras de navegación específicas por idioma, por lo que cada idioma puede tener etiquetas completamente traducidas.
No traduzcas el código en sí: los nombres de variables, las llamadas a funciones y la sintaxis son independientes del idioma. Traduce los comentarios dentro de los bloques de código si explican conceptos que los usuarios necesitan comprender. Traduce por completo las instrucciones que rodean los bloques de código.
Mintlify sirve cada versión de idioma como un conjunto independiente de páginas estáticas, por lo que un lector que visite /es/quickstart solo carga el contenido en español de esa página, no cada traducción. Añadir idiomas no cambia el peso de la página ni el rendimiento en tiempo de ejecución para los usuarios finales.Añadir idiomas sí aumenta tu repositorio y el conjunto de trabajo de tu compilación. Para mantener la escritura y la CI rápidas:
  • Almacena las imágenes traducidas en directorios específicos por idioma para que las localizaciones no utilizadas no se incluyan en el contenido de otras.
  • En repositorios grandes, limita mint broken-links y otras comprobaciones de CI a los archivos modificados en lugar de a todo el árbol.