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
Generar automáticamente páginas de SDK
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.
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.
string
El prefijo de la ruta URL para las páginas generadas. El valor predeterminado es
sdk-reference.directory único.
Usar fuentes remotas
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:
Mantener las referencias actualizadas
source.