starlight-image-zoom/README.md

Starlight plugin adding zoom capabilities to your documentation images.

<div align="center">
  <h1>starlight-image-zoom 🕵️</h1>
  <p>Starlight plugin adding zoom capabilities to your documentation images.</p>
</div>

<div align="center">
  <a href="https://github.com/HiDeoo/starlight-image-zoom/actions/workflows/integration.yml">
    <img alt="Integration Status" src="https://github.com/HiDeoo/starlight-image-zoom/actions/workflows/integration.yml/badge.svg" />
  </a>
  <a href="https://github.com/HiDeoo/starlight-image-zoom/blob/main/LICENSE">
    <img alt="License" src="https://badgen.net/github/license/HiDeoo/starlight-image-zoom" />
  </a>
  <br />
</div>

## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-image-zoom.vercel.app/getting-started/) or check out the [demo](https://starlight-image-zoom.vercel.app/demo/) to see the plugin in action.

## Features

A [Starlight](https://starlight.astro.build) plugin adding zoom capabilities to your documentation images.

- Lightweight UI based on the [`<dialog>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dialog) element
- No client-side third-party dependencies
- Markdown and MDX images support: Markdown syntax, HTML syntax, and the `<Image>` or `<Picture>` components
- Alternate text displayed as a caption
- Accessible buttons to trigger zoom

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-image-zoom/blob/main/LICENSE) for more information.