Skip to main content
Usa la propiedad de navegación sdk para generar páginas de referencia para tus bibliotecas de SDK a partir de las herramientas de documentación que ya utilizas. Mintlify lee el artefacto de compilación de cada herramienta. Después, crea una página para cada clase, interfaz, módulo y función, con grupos de navegación, enlaces entre páginas e indexación de búsqueda incluidos.

​
Formatos compatibles

​
Generar un artefacto

Ejecuta tu herramienta de documentación con un formato de salida legible por máquina. Si ya publicas documentación generada desde CI, normalmente basta con cambiar un solo flag en el mismo comando.

​
Generar automáticamente páginas de SDK

Agrega una propiedad sdk a una pestaña en tu docs.json. Mintlify analiza el artefacto y crea grupos de navegación y páginas para la biblioteca.
Debes declarar sdk en una pestaña. Una pestaña con sdk puede incluir groups, pero no otras estructuras de navegación, como pages, versions o languages. Tampoco puede incluir una propiedad openapi, asyncapi o graphql.
​
string
requerido
La herramienta de documentación que produjo el artefacto: typedoc, docfx, javadoc, sphinx o phpdoc.
​
string
requerido
Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS. No admite URLs HTTP.
​
string
El prefijo de la ruta URL para las páginas generadas. El valor predeterminado es sdk-reference.
Agrega varias pestañas para documentar varias bibliotecas. Usa un directory único para cada biblioteca para evitar colisiones de rutas.
Agrega tu directorio de artefactos a .mintignore para que Mintlify trate los artefactos como entradas de compilación en lugar de publicarlos como activos estáticos.

​
Páginas generadas

Mintlify agrega los grupos de navegación generados después de cualquier groups en la pestaña. Los grupos varían según el formato y pueden representar módulos, paquetes, espacios de nombres o tipos de símbolos. Cada página generada documenta una clase, interfaz, función, tipo u otro símbolo del artefacto y enlaza con las páginas generadas relacionadas. Si un convertidor produce páginas que no pertenecen a ningún grupo, Mintlify las recopila en un grupo Reference.

​
Usar fuentes remotas

Establece source como una URL HTTPS para obtener el artefacto en tiempo de compilación en lugar de incluirlo en tu repositorio de documentación. Los formatos de archivo único (typedoc, phpdoc) aceptan una URL directa al archivo. Los formatos de directorio (docfx, javadoc, sphinx) aceptan un archivo zip. Los jars de Javadoc publicados en Maven Central funcionan sin necesidad de reempaquetarlos:
Los artefactos remotos tienen un límite de descarga de 50 MB y un límite de tamaño extraído de 200 MB.

​
Mantener las referencias actualizadas

Regenera el artefacto siempre que tu SDK cambie. Un patrón común es un trabajo de CI en cada repositorio de SDK. Este trabajo ejecuta la herramienta de documentación al publicar una nueva versión. Después, confirma el artefacto en tu repositorio de documentación o súbelo a una URL estable a la que apunta source.

​
Configuración del repositorio

Almacena el código de tu SDK y la documentación en el mismo repositorio o en repositorios separados. Elige el patrón que se adapte a tu configuración. Ambas opciones admiten las mismas capacidades.

​
SDK y documentación en el mismo repositorio

Genera el artefacto de tu SDK en el mismo repositorio que tu documentación y apunta source a su ruta relativa. Cualquier flujo de trabajo que ya produzca el artefacto al hacer push o durante una publicación puede confirmarlo en el repositorio. Después, publica las actualizaciones como parte del siguiente despliegue del sitio de documentación.

​
SDK en un repositorio separado

Cuando el SDK está en su propio repositorio, tienes dos opciones.
  1. Confirma el artefacto en tu repositorio de documentación. En el repositorio del SDK, ejecuta un trabajo de CI al publicar una nueva versión. El trabajo debe generar el artefacto y abrir una solicitud de extracción (o hacer push de una confirmación) a tu repositorio de documentación con el archivo actualizado. Fusiona ese cambio en tu rama de despliegue para activar un despliegue del sitio. Apunta source a la ruta confirmada, igual que en la configuración de un único repositorio.
  2. Aloja el artefacto y obténlo durante la compilación. Sube el artefacto a una URL HTTPS estable. Por ejemplo, un bucket de S3, un activo de GitHub Releases o Maven Central para jars de Javadoc. Establece source en la URL. Activa un despliegue del sitio de documentación para obtener el nuevo artefacto cada vez que lo actualices. Llama al endpoint Activar despliegue desde el flujo de publicación de tu SDK después de publicar el artefacto.
Si publicas con poca frecuencia o quieres que el repositorio de documentación sea la fuente de verdad, confirma el artefacto en tu repositorio de documentación. Si publicas con frecuencia, los artefactos son grandes o ya los publicas (por ejemplo, jars de Javadoc en Maven Central), aloja el artefacto y obténlo durante la compilación.