
La opción
downloadApiSpec solo aparece en páginas de referencia de API (páginas cuyo frontmatter declara api, openapi o asyncapi). En despliegues con autenticación o autenticación de usuario habilitada, solo los lectores autenticados pueden descargar la especificación.contextual a tu archivo docs.json y especifica qué opciones quieres incluir.
Ubicación de visualización
display.
Agregar opciones personalizadas
options. Cada opción personalizada requiere estas propiedades:
El título de la opción.
La descripción de la opción. Se muestra debajo del título cuando el menú contextual se expande.
Debes proporcionar
icon o src.El icono que se mostrará desde una biblioteca de iconos.Options:
- Font Awesome icon name, if you have the
icons.libraryproperty set tofontawesomein yourdocs.json - Lucide icon name, if you have the
icons.libraryproperty set tolucidein yourdocs.json - Nombre del icono Tabler, si tienes la
icons.librarypropiedad configurada comotableren tudocs.json
Ruta o URL de una imagen para usar como icono. Usa
src en lugar de icon cuando quieras utilizar una imagen personalizada en lugar de un icono de una biblioteca.Options:- Ruta a un archivo de imagen en tu proyecto (por ejemplo,
/images/mi-icono.svg) - URL de una imagen alojada externamente (por ejemplo,
https://example.com/icon.png)
The Font Awesome icon style. Only used with Font Awesome icons.Options:
regular, solid, light, thin, sharp-solid, duotone, brands.El href de la opción. Usa una cadena para enlaces simples o un objeto para enlaces dinámicos con parámetros de búsqueda.
Sobrescribir en páginas individuales
contextual al frontmatter de la página. Úsalo para mostrar acciones específicas de la página, como download-pdf en una página de términos de servicio, u ocultar el menú por completo en una landing page.
El objeto contextual a nivel de página reemplaza al global en esa página. Omite el campo para heredar docs.json, o define options: [] para desactivar el menú contextual en esa página.
docs.json, incluidas las opciones personalizadas y la configuración display. Si la sobrescritura de página no es válida, Mintlify utiliza la configuración global de contextual.
Ejemplos de opciones personalizadas
Enlace simple
Enlace simple
Enlace dinámico con contenido de la página
Enlace dinámico con contenido de la página