added docs
This commit is contained in:
committed by
Kyle Brown
parent
c950785385
commit
be308d516f
27
docs/capsword.md
Normal file
27
docs/capsword.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# CapsWord
|
||||
The CapsWord module makes a key available that will function similar to caps lock but will deactive automatically when its encounters a key that breaks the word or after inactivity timeout.
|
||||
By default it will not deactive capsword on numbers, alphabets, underscore, modifiers, minus, backspace and other keys like modtap, layers, etc
|
||||
Add it to your keyboard's modules list with:
|
||||
|
||||
```python
|
||||
from kmk.modules.capsword import CapsWord
|
||||
# default inactivity timeout is 8s
|
||||
caps_word=CapsWord()
|
||||
# change inactivity timeout
|
||||
# caps_word=CapsWord(timeout=5000)
|
||||
# for no inactivity timeout
|
||||
# caps_word=CapsWord(timeout=0)
|
||||
# add additional ignored keys
|
||||
# caps_word.keys_ignored.append(KC.COMMA)
|
||||
keyboard.modules.append(caps_word)
|
||||
keyboard.keymap = [
|
||||
[
|
||||
KC.CW,
|
||||
],
|
||||
]
|
||||
```
|
||||
## Keycodes
|
||||
|
||||
|Key |Aliases |Description |
|
||||
|-----------------------|--------------------|-----------------------------------------------|
|
||||
|`KC.CW` |`KC.CAPSWORD` |Enables/disables capsword |
|
Reference in New Issue
Block a user