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.


pip install toro-mkdocs-kbd


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.


The produced HTML of the markdown syntax will be:

<p><kbd linux="Ctrl + A" macos="⌘A" winodws="Ctrl + A"></kbd></p>


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

Release history Release notifications

Download files

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

Files for toro-mkdocs-kbd, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size toro_mkdocs_kbd-1.0.0-py3-none-any.whl (2.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size toro-mkdocs-kbd-1.0.0.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page