MyST Markdown can be used to include images and figures in your notebooks as well as referencing those images easily in other cells of the notebook.
Simple Images¶
Adding an image to your notebook using the standard Markdown syntax will work as usual with the standard markdown syntax:
Figure Directives¶
By switching to MyST Directives or figures (and images) can be inserted with some additional control. figures can also be cross-referenced in other places in the notebook. For example, the following figure:
Has a name attribute allows you to cross-reference the figure from any other markdown cell in the notebook using the familiar markdown link syntax (see the documentation on Cross References).
The figure directive is similar to image but allows for a caption and sequential figure numbering.
Cell Attachments¶
Notebooks allow images to be added as cell attachments. This is typically achieved via drag and drop in the notebook interface and results in the image being added to the notebook itself as a base64 encoded string.
Cell attachments are inserted into the notebook using standard markdown syntax such as:
These links are inserted automatically by jupyter when an attachment is added. Once the link syntax is known these can be changed to image or figure directives where captions can be added attributes can be used to, for example control the image size. Attachments are cell specific, so this will only work in the same cell that the attachment was added.