Captions and alt text

Options map

Floating

image

Images embed visual assets in a Mechdown document and can include captions and display options.

Use Markdown-style image syntax:

![alt-text](image-url)

Captions and alt text

In Mechdown, alt text may be rendered as a caption. Figure numbering is automatically generated based on document order.

Options map

An optional options map can set attributes such as width, height, or alignment.

![Mech logo](https://github.com/mech-lang/assets/blob/main/images/mech-m2.png?raw=true)
![Small logo](https://github.com/mech-lang/assets/blob/main/images/mech-m2.png?raw=true){width: "100px", height: "100px"}

Floating

Use float markers to wrap text around an image:

  • << float left

  • >> float right

Prefer concise alt text that describes the figure's purpose, not only its appearance.