Move docs/ to docs/en/
It allows comparison between the directories and helps translations.
This commit is contained in:
committed by
Kyle Brown
parent
885359a8f4
commit
0ab6887fbe
29
docs/en/extension_stringy_keymaps.md
Normal file
29
docs/en/extension_stringy_keymaps.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Stringy Keymaps
|
||||
|
||||
Enables referring to keys by `'NAME'` rather than `KC.NAME`.
|
||||
|
||||
For example:
|
||||
|
||||
```python
|
||||
from kmk.extensions.stringy_keymaps import StringyKeymaps
|
||||
|
||||
# Normal
|
||||
# keyboard.keymap = [[ KC.A, KC.B, KC.RESET ]]
|
||||
|
||||
# Indexed
|
||||
# keyboard.keymap = [[ KC['A'], KC['B'], KC['RESET'] ]]
|
||||
|
||||
# String names
|
||||
keyboard.keymap = [[ 'A' , 'B', 'RESET' ]]
|
||||
|
||||
stringyKeymaps = StringyKeymaps()
|
||||
|
||||
# Enabling debug will show each replacement or failure.
|
||||
# This is recommended during the initial development of a keyboard.
|
||||
# stringyKeymaps.debug_enable = True
|
||||
|
||||
keyboard.extensions.append(stringyKeymaps)
|
||||
```
|
||||
|
||||
It should be noted that these are **not** ASCII. The string is **not** what
|
||||
will be sent to the computer. The examples above have no functional difference.
|
Reference in New Issue
Block a user