# keyle

<p align="center">
  <a href="https://github.com/magicwenli/keyle/blob/main/doc/keyle.pdf">
    <img alt="Documentation" src="https://img.shields.io/website?down_message=offline&label=manual&up_color=007aff&up_message=online&url=https://github.com/magicwenli/keyle/blob/main/doc/keyle.pdf" />
  </a>
  <a href="https://github.com/magicwenli/keyle/blob/main/LICENSE">
    <img alt="MIT License" src="https://img.shields.io/badge/license-MIT-brightgreen">
  </a>
</p>

A simple way to style keyboard shortcuts in your documentation.

This package was inspired by [auth0/kbd](https://auth0.github.io/kbd/) and [dogezen/badgery](https://github.com/dogezen/badgery). Send them respect and love.

## Usage

Please see the [keyle.pdf](https://github.com/magicwenli/keyle/blob/main/doc/keyle.pdf) for more documentation.

`keyle` is imported using:

```typst
#import "@preview/keyle:0.1.1"
```

### Example

![About](doc/keyle.png)

## License

MIT
