Estructura de archivos
Example file structure
Configurar el selector de idioma
languages en la propiedad navigation de tu docs.json.
docs.json
languages requiere:
language: código de idioma ISO 639-1- Estructura completa de navigation
- Rutas de los archivos traducidos
Establecer el idioma predeterminado
languages se usa automáticamente como idioma predeterminado. Para establecer otro idioma como predeterminado, reordena el arreglo o agrega la propiedad default:
docs.json
default para modificar el orden:
docs.json
Documentación en un solo idioma
languages de tu configuración de navigation. En su lugar, define directamente tu estructura de navigation:
docs.json
global dentro de la navigation de tu docs.json.
docs.json
footer y navbar a la configuración de cada idioma:
docs.json
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
Flujo de trabajo de traducción
- Actualiza el contenido original en tu idioma principal.
- Identifica el contenido modificado.
- Traduce el contenido modificado.
- Revisa las traducciones para comprobar su precisión.
- Actualiza los archivos traducidos.
- Verifica que la navegación y los enlaces funcionen.
Traducciones automatizadas
Proveedores de traducción externos
- Exportar el contenido fuente: Extrae los archivos MDX que necesiten traducción.
- Enviar a los traductores: Proporciona los archivos a tu proveedor de traducción.
- Recibir las traducciones: Recibe de vuelta los archivos MDX traducidos.
- Importar y desplegar: Añade los archivos traducidos a los directorios de idioma y actualiza la navegación.
.github/workflows/export-for-translation.yml
.github/workflows/import-translations.yml
- Conserva el frontmatter: Asegúrate de que los traductores mantengan intacto el frontmatter en YAML y traduzcan solo los valores de
titleydescription. - 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
es/index.mdx
SEO para sitios multilingües
Metadata de la página
fr/index.mdx
Mejores prácticas
Formatos de fecha y número
- 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€
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
- 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
Preguntas frecuentes
¿Necesito traducir cada página antes de lanzar un nuevo idioma?
¿Necesito traducir cada página antes de lanzar un nuevo idioma?
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.
¿Qué pasa cuando falta una página traducida?
¿Qué pasa cuando falta una página traducida?
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.
¿Cómo manejo los ejemplos de código en el contenido traducido?
¿Cómo manejo los ejemplos de código en el contenido traducido?
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.
¿Añadir más idiomas afecta el rendimiento del sitio?
¿Añadir más idiomas afecta el rendimiento del sitio?
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-linksy otras comprobaciones de CI a los archivos modificados en lugar de a todo el árbol.