Skip to main content

A Python markdown extension for wrapping keyboard shortcuts in a special tag

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toro-mkdocs-kbd-1.0.0.tar.gz (2.6 kB view hashes)

Uploaded source

Built Distribution

toro_mkdocs_kbd-1.0.0-py3-none-any.whl (2.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page