Skip to main content
Añade imágenes, incrusta videos e incluye contenido interactivo con iframes en tu documentación. Todos los archivos estáticos de tu repositorio de documentación se sirven automáticamente en la ruta correspondiente de tu dominio. Por ejemplo, si tienes /images/my-logo.png en tu repo, la imagen estará disponible en https://docs.yoursite.com/images/my-logo.png.
Fotografía de un paisaje con flores moradas en primer plano, montañas al fondo y un cielo azul con nubes dispersas.

Imágenes

Añade imágenes para aportar contexto visual, ejemplos o elementos decorativos a tu documentación.

Sintaxis básica de imágenes

Usa la sintaxis de Markdown para agregar imágenes a tu documentación:
Incluye siempre texto alternativo descriptivo para mejorar la accesibilidad y el SEO. El texto alternativo debe describir con claridad lo que muestra la imagen.
Los archivos de imagen deben pesar menos de 20 MB. Para archivos más grandes, aloja el contenido en un servicio CDN como Amazon S3 o Cloudinary.

Inserciones de imágenes en HTML

Para tener más control sobre la visualización de imágenes, usa etiquetas <img> de HTML:

Desactivar la funcionalidad de zoom

Para desactivar el zoom predeterminado al hacer clic en las imágenes, agrega la propiedad noZoom:
Para convertir una imagen en un enlace clicable, envuelve la imagen en una etiqueta de enlace (anchor) y agrega la propiedad noZoom:
Las imágenes dentro de etiquetas de enlace muestran automáticamente un cursor de puntero para indicar que se pueden hacer clic.

Imágenes para modos claro y oscuro

Para mostrar imágenes distintas en los temas claro y oscuro, usa clases de Tailwind CSS:

Videos

Mintlify admite etiquetas HTML en Markdown, lo que te da flexibilidad para crear contenido enriquecido.
Incluye siempre contenido de texto de respaldo dentro de los elementos de video para los navegadores que no admiten la reproducción de video.

Insertar contenido de YouTube

Inserta videos de YouTube usando elementos iframe:

Videos autoalojados

Usa el elemento HTML <video> para contenido de vídeo autoalojado:

Reproducción automática de vídeos

Para reproducir un vídeo automáticamente, usa:
Al usar la sintaxis JSX, escribe los atributos compuestos en camelCase: autoPlay, playsInline, allowFullScreen.

iframes

Incorpora contenido externo con elementos iframe:

Referencia del componente Frame

Aprende a usar el componente Frame para presentar imágenes.