Image

The Image component allows you to add responsive and styled images to your markdown pages. This component is useful for embedding images with optional alignment, width, and height settings, and includes accessibility features through the description attribute.

Examples

Custom size

Sample placeholder image

Aligned Left

Sample placeholder image

With Border & Custom Padding

Sample placeholder image

Options

Required

The URL of the image.

The description of the image for accessibility purposes.

The width of the image (in pixels)

Options:
number

The height of the image (in pixels)

Options:
number

Whether to display a border around the image

Options:
Default:
false

The alignment of the image

Default:
center

Pass custom classes to control the styling of an accordion item. Supports tailwind classes.