Imágenes e inserciones

Agrega imágenes, inserta videos e incluye contenido interactivo con iframes en tu documentación.

Fotografía de un paisaje con flores moradas en primer plano, montañas al fondo y un cielo azul con nubes dispersas.

Imágenes

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

Sintaxis básica de imágenes

Utiliza la sintaxis de Markdown para añadir imágenes a tu documentación:

![Texto alternativo que describe la imagen](/images/screenshot.png)

Las rutas de las imágenes son relativas a la raíz de tu repositorio de documentación. Por ejemplo, si tu imagen está en images/screenshot.png en tu repositorio, la ruta es /images/screenshot.png. Las rutas relativas (por ejemplo, ./screenshot.png) no son compatibles.

Incluye siempre texto alternativo descriptivo para mejorar la accesibilidad y el SEO. El texto alternativo debe describir claramente lo que muestra la imagen.

Los archivos de imagen deben pesar menos de 20 MB. Para archivos más grandes, alójalos en un servicio CDN como Amazon S3 o Cloudinary.

Inserciones de imágenes HTML

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

<img 
  src="/images/dashboard.png" 
  alt="Interfaz principal del dashboard"
  style={{height: "300px", width: "400px"}}
  className="rounded-lg"
/>

Cambiar el tamaño de imágenes con estilos en línea

Usa estilos en línea de JSX con el atributo style para cambiar el tamaño de las imágenes:

<img
  src="/images/architecture.png"
  style={{width: "450px", height: "auto"}}
  alt="Diagrama que muestra la arquitectura del sistema"
/>

Desactivar el zoom de las imágenes

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
/>

Enlazar imágenes

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

<a href="https://mintlify.com" target="_blank">
  <img 
    src="/images/logo.png" 
    alt="Logotipo de Mintlify"
    noZoom
  />
</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 los modos claro y oscuro

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

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

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

Imágenes SVG

Los archivos SVG que usan elementos foreignObject se renderizan de forma diferente en producción que en el entorno de desarrollo local. La CDN de imágenes de Mintlify elimina foreignObject de los SVG como medida de seguridad, lo que puede truncar u ocultar texto y otros contenidos HTML incrustados. Esto suele afectar a los SVG exportados desde herramientas como draw.io que tienen el formato de texto HTML o el ajuste de línea activados. Para solucionarlo, desactiva Formatted Text y Word Wrap en todas las etiquetas de tu diagrama antes de exportarlo como SVG. Consulta la documentación de draw.io para obtener más información sobre las exportaciones de SVG.

Videos

Mintlify admite etiquetas HTML en Markdown, lo que te brinda flexibilidad para crear contenido enriquecido.

Incluye siempre texto alternativo dentro de los elementos de video para los navegadores que no admiten la reproducción de video.

Videos de YouTube incrustados

Incrusta videos de YouTube mediante elementos iframe:

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

Videos autoalojados

Usa el elemento HTML <video> para contenido de video 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 de JSX, escribe los atributos de dos palabras 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>

Envuelve los iframes en un componente frame para mantenerlos dentro del ancho de la columna de texto y evitar desbordamientos.

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

Referencia del componente Frame

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

​Imágenes

​Sintaxis básica de imágenes

​Inserciones de imágenes HTML

​Cambiar el tamaño de imágenes con estilos en línea

​Desactivar el zoom de las imágenes

​Enlazar imágenes

​Imágenes para los modos claro y oscuro

​Imágenes SVG

​Videos

​Videos de YouTube incrustados

​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 HTML

Cambiar el tamaño de imágenes con estilos en línea

Desactivar el zoom de las imágenes

Enlazar imágenes

Imágenes para los modos claro y oscuro

Imágenes SVG

Videos

Videos de YouTube incrustados

Videos autoalojados

Reproducción automática de vídeos

Iframes

Recursos relacionados