MkKeys
Node to display Keyboard keys.¶
Description
Mostly used to explain shortcuts / commands for the keyboard.
Name | Children | Inherits |
---|---|---|
MkNode mknodes.basenodes.mknode Base class for everything which can be expressed as Markup. |
graph TD
94875592355152["mkkeys.MkKeys"]
94875594508576["mknode.MkNode"]
94875592833088["node.Node"]
140216716431552["builtins.object"]
94875594508576 --> 94875592355152
94875592833088 --> 94875594508576
140216716431552 --> 94875592833088
/home/runner/work/mknodes/mknodes/mknodes/basenodes/mkkeys/metadata.toml
[metadata]
icon = "fa6-regular:keyboard"
name = "MkKeys"
[requirements.extension."pymdownx.keys"]
[examples.single_key]
title = "Single key"
jinja = """
{{ "M" | MkKeys }}
"""
[examples.multiple_keys]
title = "Multiple keys"
jinja = """
{{ "M+k+K+e+y+s" | MkKeys }}
"""
[examples.modifiers]
title = "Modifiers"
jinja = """
{{ "Ctrl+A" | MkKeys }}
"""
[examples.as_list]
title = "As list"
jinja = """
{{ ["Alt", "X"] | MkKeys }}
"""
[output.markdown]
template = """
++{{ node.keys | join("+") }}++
"""