Mintlify

¿Qué es Mintlify?

Mintlify es una plataforma de documentación que crea sitios de documentación hermosos y personalizables. Proporciona funciones integradas de búsqueda, analíticas y playground de API para crear documentación moderna para desarrolladores.

¿Qué es Lingo.dev CLI?

Lingo.dev es una plataforma de traducción impulsada por IA. El CLI de Lingo.dev lee archivos fuente, envía contenido traducible a modelos de lenguaje grandes y escribe los archivos traducidos de vuelta a tu proyecto.

Acerca de esta guía

Esta guía explica cómo configurar Lingo.dev CLI en un sitio de documentación de Mintlify. Aprenderás cómo estructurar un proyecto con Mintlify, configurar un pipeline de traducción y ver los resultados.

Paso 1. Configurar un proyecto de Mintlify

1. Instala el CLI de Mintlify:

   npm i -g mint
   

2. Clona la plantilla inicial de Mintlify:

   git clone https://github.com/mintlify/starter.git
   

3. Navega al directorio del proyecto:

   cd starter
   

Paso 2. Crear contenido fuente

1. Crea un directorio para almacenar la documentación en el idioma fuente:

   mkdir en
   

2. Crea un archivo que contenga algo de contenido de documentación (p. ej., en/overview.mdx):

   ---
   title: "Introduction"
   description: "Welcome to the new home for your documentation"
   ---
   
   ## Getting started
   
   This documentation is automatically translated by Lingo.dev.
   
   ## Features
   
   Our product includes powerful capabilities for modern development.
   

Paso 3. Configurar el CLI

En la raíz del proyecto, crea un archivo i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

Este archivo define:

• los archivos que Lingo.dev CLI debe traducir
• los idiomas entre los que traducir

En este caso, la configuración traduce archivos MDX del inglés al español.

Es importante tener en cuenta que:

• [locale] es un marcador de posición que se reemplaza en tiempo de ejecución. Garantiza que el contenido se lea desde una ubicación (por ejemplo, en/index.mdx) y se escriba en una ubicación diferente (por ejemplo, es/index.mdx).
• Lingo.dev CLI no admite patrones glob recursivos (por ejemplo, **/*.mdx). Deberás crear patrones include adicionales para traducir archivos que existan dentro de directorios anidados.

Para obtener más información, consulta configuración de i18n.json.

Paso 4. Traducir el contenido

1. Regístrate para obtener una cuenta de Lingo.dev.

2. Inicia sesión en Lingo.dev a través de la CLI:

   npx lingo.dev@latest login
   

3. Ejecuta el pipeline de traducción:

   npx lingo.dev@latest run
   

   La CLI creará un directorio es/ para almacenar el contenido traducido y un archivo i18n.lock para realizar un seguimiento de lo que se ha traducido (para evitar retraducciones innecesarias).

Paso 5. Usar las traducciones

1. En el archivo docs.json, añade una propiedad languages al objeto navigation:

   {
     "navigation": {
       "languages": []
     }
   }
   

2. Para cada idioma compatible, añade un objeto independiente al array:

   {
     "navigation": {
       "languages": [
         {
           "language": "en",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["en/overview"]
             }
           ]
         },
         {
           "language": "es",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["es/overview"]
             }
           ]
         }
       ]
     }
   }
   

   Ten en cuenta que:

   • Deberás replicar toda la estructura de navegación por separado para cada idioma.
   • Mintlify solo admite un subconjunto de los idiomas que admite Lingo.dev CLI.

3. Inicia el servidor de desarrollo:

   mint dev
   

4. Navega a http://localhost:3000. Deberías ver un menú desplegable para cambiar entre idiomas.

Limitaciones conocidas

• Cualquier texto de interfaz que esté definido en el archivo docs.json (por ejemplo, etiquetas de grupos de la barra lateral, texto de marcador de posición de búsqueda, etc.) no se traducirá.

Idiomas compatibles

Mintlify solo admite un subconjunto de los idiomas que admite Lingo.dev CLI. Para obtener la lista más actualizada, consulta la documentación oficial.