Images¶

Images allow you to embed visual content in your documentation to support and enhance the information presented.

Syntax¶

Images in MyST Markdown are embedded using the ![alt text](image URL) syntax. The general format is:

![Alt text](image_url)

Optionally, you can add a title to the image by providing it after the URL:

![Alt text](image_url "Title text")

Examples¶

Simple Image¶

![A sample image](https://bluerobotics.com/wp-content/uploads/2020/01/BlueRobotics-Logo-Blue-Black.png)

Renders:

Local image¶

![A sample image](/_static/sample.png)

Renders:

Image with title¶

![A sample image](https://bluerobotics.com/wp-content/uploads/2020/01/BlueRobotics-Logo-Blue-Black.png "This is a sample image")

Renders:

See also¶

• MyST Parser: Images and figures

• Sphinx: reStructuredText Primer