Metadata-Version: 2.1
Name: toro-shortcuts
Version: 1.4
Summary: A Python Markdown extension for keyboard shortcuts
Home-page: https://www.torocloud.com/
Author: Steven Larry Ball
Author-email: stevenlarry.ball@torocloud.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

#### Introduction
The toro-shortcut converts your keyboard shortcut into a customized tag. The tag will contain three
attributes; linux, macos, and windows. The values in the attributes will be the keyboard shortcut
using the symbols of the corresponding OS.

#### Installation
```
pip install toro-shortcuts
```
#### Usage
The markdown syntax will be the keyboard shortcut between two questions marks. A plus sign will be used
to separate the keys. __MOD__ will be used as a generic symbol for both the __ctrl__ and __command__ key.
```
??MOD+A??
```

The produced HTML of the markdown syntax will be:
```
<p><kbd linux="Ctrl + A" macos="⌘A" winodws="Ctrl + A"></kbd></p>
```

#### Conversion

| Markdown        | Windows/Linux | macOS |
|:---------------:|:-------------:|:-----:|
| ??mod??         | Ctrl          | ⌘     |
| ??alt??         | Alt           | ⌥     |
| ??enter??       | Enter         | ↩     |
| ??shift??       | Shift         | ⇧     |
| ??ctrl??        | Ctrl          | ⌃     |
| ??left??        | Left          | ←     |
| ??right??       | Right         | →     |
| ??up??          | Up            | ↑     |
| ??down??        | Down          | ↓     |
| ??tab??         | Tab           | ⇥     |
| ??esc??         | Esc           | ⎋     |
| ??space??       | Space         | Space |


