TORO KBD Markdown Extension
The toro-mkdocs-kbd wraps your keyboard shortcut into a KBD tag. The tag will contain three attributes; linux, macos, and windows. The values in the attributes will be the keyboard shortcut based on the OS.
Installation
pip install toro-mkdocs-kbd
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 |
Metadata
Release files for toro-mkdocs-kbd 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| toro-mkdocs-kbd-1.0.0.tar.gz | 2.6 kB | Without provenance | Details for toro-mkdocs-kbd-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| toro_mkdocs_kbd-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for toro_mkdocs_kbd-1.0.0-py3-none-any.whl |
Total release size: 5.5 kB
Release files / toro-mkdocs-kbd-1.0.0.tar.gz
| Download URL | toro-mkdocs-kbd-1.0.0.tar.gz |
|---|---|
| Size | 2.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00e023c18fe7de32b8084cebb466c4c758d87ac984cddaecaa731674a093c951
|
|
BLAKE2b-256 checksum How to use checksums |
f8c94341c26962009b69e6e3d0dbb8b5076a4a2ce3aafb5bfe528d6ace76f03d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/1.1.6 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.10
|
Release files / toro_mkdocs_kbd-1.0.0-py3-none-any.whl
| Download URL | toro_mkdocs_kbd-1.0.0-py3-none-any.whl |
|---|---|
| Size | 2.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a2b712211885edf1e8b0173d431c3ffbfc28e21d91b150f7eb54e2e249606b93
|
|
BLAKE2b-256 checksum How to use checksums |
88d1e4eef2c11a96c23ed6114cfda5f396d54fa25475c11368ecb5906fc22332
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/1.1.6 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.10
|
Security for toro-mkdocs-kbd 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.