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 y 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 que ejecuta la herramienta de documentación al publicar una nueva versión y luego confirma el artefacto en tu repositorio de documentación o lo sube a una URL estable a la que apunta source.