Imágenes y contenido incrustado

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:

![Texto alternativo que describe la imagen](/path/to/image.png)

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:

<img 
  src="/images/dashboard.png" 
  alt="Interfaz del panel principal"
  height="300"
  className="rounded-lg"
/>

Desactivar la funcionalidad de zoom

Para desactivar el zoom predeterminado al hacer clic en las imágenes, agrega la propiedad noZoom:

<img 
  src="/images/screenshot.png" 
  alt="Texto alternativo descriptivo"
  noZoom 
  height="200"
/>

Enlazar imágenes

Para convertir una imagen en un enlace clicable, envuelve la imagen en una etiqueta de enlace (anchor) y agrega la propiedad noZoom:

<a href="https://mintlify.com" target="_blank">
  <img 
    src="/images/logo.png" 
    alt="Logo de Mintlify"
    noZoom 
    height="100"
  />
</a>

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:

<!-- Imagen de modo claro -->
<img 
  className="block dark:hidden" 
  src="/images/light-mode.png" 
  alt="Interfaz de modo claro"
/>

<!-- Imagen de modo oscuro -->
<img 
  className="hidden dark:block" 
  src="/images/dark-mode.png" 
  alt="Interfaz de modo oscuro"
/>

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:

<iframe
  className="w-full aspect-video rounded-xl"
  src="https://www.youtube.com/embed/4KzFe50RQkQ"
  title="Reproductor de vídeo de YouTube"
  frameBorder="0"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
  allowFullScreen
></iframe>

Videos autoalojados

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

<video
  controls
  className="w-full aspect-video rounded-xl"
  src="enlace-a-tu-video.com"
></video>

Reproducción automática de vídeos

Para reproducir un vídeo automáticamente, usa:

<video
  autoPlay
  muted
  loop
  playsInline
  className="w-full aspect-video rounded-xl"
  src="/videos/demo.mp4"
></video>

Al usar la sintaxis JSX, escribe los atributos compuestos en camelCase: autoPlay, playsInline, allowFullScreen.

iframes

Incorpora contenido externo con elementos iframe:

<iframe 
  src="https://example.com/embed" 
  title="Contenido integrado"
  className="w-full h-96 rounded-xl"
></iframe>

Referencia del componente Frame

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

Primeros pasos

Configuración principal

Optimización de IA

Componentes

Páginas de API

Autenticación y personalización

Guías

Integraciones

Control de versiones y CI/CD

Imágenes y contenido incrustado

Imágenes

Sintaxis básica de imágenes

Inserciones de imágenes en HTML

Desactivar la funcionalidad de zoom

Enlazar imágenes

Imágenes para modos claro y oscuro

Videos

Insertar contenido de YouTube

Videos autoalojados

Reproducción automática de vídeos

iframes

Referencia del componente Frame

​Imágenes

​Sintaxis básica de imágenes

​Inserciones de imágenes en HTML

​Desactivar la funcionalidad de zoom

​Enlazar imágenes

​Imágenes para modos claro y oscuro

​Videos

​Insertar contenido de YouTube

​Videos autoalojados

​Reproducción automática de vídeos

​iframes

​Recursos relacionados

Referencia del componente Frame

Imágenes

Sintaxis básica de imágenes

Inserciones de imágenes en HTML

Desactivar la funcionalidad de zoom

Enlazar imágenes

Imágenes para modos claro y oscuro

Videos

Insertar contenido de YouTube

Videos autoalojados

Reproducción automática de vídeos

iframes

Recursos relacionados