Images and figures
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.
The simplest way to create an image is to use the standard Markdown syntax:
You can explore a demo of images in the discussion of CommonMark features of MyST.
Using standard markdow 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. For example, the image width, alignment or a figure caption cannot be set with this syntax.
There are two directives that can be used to add additional information about the layout and metadata associated with an image.
imagedirective allows you to customize width, alignment, and other classes to add to the image
figuredirective can contain a figure caption and allows you to cross-reference this in other parts of your document.
Supported Image Formats¶
MyST supports many images formats including
Many of these image formats are easily supported for HTML themes including
.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.
There are formats that are not supported by web-browsers but are common in scientific writing like
.eps for site builds, these are converted to
.png as appropriate and available. For export to , PDF or Microsoft Word, the files are converted to an appropriate format that the export can handle (e.g. can work directly with
.gif, the first frame is extracted for static exports.
Installing Image Converters
The image translations and optimizations requires you to have the following packages installed:
- imagemagik for conversion between raster formats
- inkscape for conversion between some vector formats
- webp for image optimizations
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:
For example, when exporting to the best format is a
.svg will be chosen before a
.png. In all cases, if an appropriate format is not available the image will be translated.