kmk_firmware/docs/en/README.md
Phong Le 2ccad46e26
update modtap to holdtap (#718)
* update modtap to holdtap

* Update links

* Revert "Update links"

This reverts commit 8d0cda7c5a.

* updated docs links

update links in docs

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* rename modtap.md to holdtap.md

* Update Getting_Started.md

* Update main.py

* Update modtap.py

* Update modtap.py and add notice

* Update docs/en/porting_to_kmk.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/handwiring.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/ble_hid.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/kmkpython_vs_circuitpython.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Rename modtap.md to holdtap.md

* fixup

---------

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
2023-03-03 09:32:41 +00:00

2.6 KiB

Documentation index

Before you look further, you probably want to start with our getting started guide

Basics

Advanced

Modules

  • Combos: Adds chords and sequences
  • Layers: Adds layer support (Fn key) to allow many more keys to be put on your keyboard
  • HoldTap: Adds support for augmented modifier keys to act as one key when tapped, and modifier when held.
  • Mouse keys: Adds mouse keycodes
  • OneShot: Adds support for oneshot/sticky keys.
  • Power: Power saving features. This is mostly useful when on battery power.
  • SerialACE: [DANGER - see module README] Arbitrary Code Execution over the data serial.
  • Split: Keyboards split in two. Seems ergonomic!
  • TapDance: Different key actions depending on how often it is pressed.

Peripherals

Extensions

  • International: Adds international keycodes
  • LED: Adds backlight support. This is for monocolor backlight, not RGB
  • LockStatus: Exposes host-side locks like caps or num lock.
  • MediaKeys: Adds support for media keys such as volume
  • RGB: RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow.
  • Status LED: Indicates which layer you are on with an array of single leds.

Language versions