Images, Figures and Videos

MyST Markdown can be used to include images and figures in your documents as well as referencing those images easily throughout your website, article or paper.

Simple images¶

The simplest way to create an image is to use the standard Markdown syntax:

![alt](link 'title')

You can explore a demo of images in the discussion of CommonMark features of MyST.

Using standard markdown to create an image will render across all output formats (HTML, TeX, Word, PDF, etc). However, this markdown syntax is limited in the configuration that can be applied beyond alt text and an optional title.

There are two directives that can be used to add additional information about the layout and metadata associated with an image. For example, {image.width}, {alignment.align} or a {figure caption.body}.

image

The {image} directive allows you to customize {image.width}, {alignment.align}, and other {classes.class} to add to the image

figure

The {figure} directive can contain a {figure caption.body} and allows you to cross-reference this in other parts of your document.

Image directive¶

Figure directive¶

Subfigures¶

Subfigures can be created by omitting the directive argument to figure, and having the body contain one or more images or figures. These will be numbered as Figure 1a and Figure 1b, etc. For example:

You can also cross-reference either the whole figure Figure 1, or an individual subfigure Figure 1a or Figure 1b. Each subfigure is given an implicit reference that matches the figure label with a suffix of their letter, for example, a figure with label my-figure the two subfigures can be referred to as my-figure-a and my-figure-b, respectively. If you provide a specific label for a subfigure, that label will be used instead of the implicit label.

By default, when referring to subfigures, the {number} that is used includes the parent enumerator (that is: 1a rather than just a). To specifically use the sub-enumerator only, you can use the syntax {subEnumerator} in your text link which will be replaced with the sub-enumerator (that is: a rather than 1a).

Supported Image Formats¶

MyST supports many images formats including .png, .jpg, .gif, .tiff, .svg, .pdf, and .eps. Many of these image formats are easily supported for HTML themes including .png, .jpg and .gif. However, the raster image formats can be further optimized to improve site performance, MyST translates these to the modern .webp format while the site is building. The original file-format is also included your site, with a srcset and fallback for older web-browsers.

PNG

JPG

GIF

TIFF

SVG

PDF

EPS

Image Transformers¶

There are formats that are not supported by web-browsers but are common in scientific writing like .tiff, .pdf and .eps for site builds, these are converted to .svg or .png as appropriate and available. For export to $\LaTeX$, PDF or Microsoft Word, the files are converted to an appropriate format that the export can handle (e.g. $\LaTeX$ can work directly with .pdf images). For animated images, .gif, the first frame is extracted for static exports.

Multiple Images¶

If you have manually converted your images or have different images for different formats, use an asterisk (*) as the extension. All images matching the provided pattern will be found and the best image out of the available candidates will be used for the export:

![](./images/myst-image.*)

For example, when exporting to $\LaTeX$ the best format is a .pdf if it is available; in a web export, a .webp or .svg will be chosen before a .png. In all cases, if an appropriate format is not available the image will be translated.

Videos¶

To embed a video you can either use a video platforms embed script or directly embed an mp4 video file. For example:

:::{figure} ./videos/links.mp4
An embedded video with a caption!
:::

or

![](./videos/links.mp4)

will copy the video to your static files and embed a video in your HTML output.

If you have ffmpeg installed, you may also include .mov and .avi video files, and MyST will convert them to .mp4 and include them. Videos can also be used in the image or even in simple Markdown image.

Use an image in place of a video for static exports¶

If you’d like an image to display for static exports (like PDFs), use the asterisk (*) wildcard matching described in Multiple Images.

For example, if you had the following two files:

myvideo.mp4  <-- A video of something
myvideo.png <-- A frame of the video as an image

Then you could link them both with:

![](myvideo.*)

When you build an HTML output, the video will be used, and when you build a PDF output, the image will be used.

YouTube Videos¶

If your video is on a platform like YouTube or Vimeo, you can use the {iframe} directive that takes the URL of the video.

You can find this URL when clicking share > embed on various platforms. You can also give the {iframe} directive {iframe.width} and a {caption.body}.

Provide Light and Dark Mode images¶

To provide images for light and dark mode, use Tailwind CSS classes for light and dark mode.