2ccad46e26
* 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>
2.6 KiB
2.6 KiB
Documentation index
Before you look further, you probably want to start with our getting started guide
Basics
- Getting Started
- Bluetooth HID: Connect keyboard to PC or mobile device using BLE
- Configuring KMK
- Porting to KMK: Creating a
kb.py
file for a board - Debugging
- Keycodes: List of all available keycodes
- Officially supported microcontrollers
- Support
- Contributing
Advanced
- Flashing instructions
- Handwiring: Resources helpful when handwiring a keyboard circuit
- Keys: Technical explanation of key handling
- Scanners: Setting up non-default key reading
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
- ADNS9800: Controlling ADNS9800 optical sensor
- Encoder: Handling rotary encoders
- Pimoroni trackball: Handling a small I2C trackball made by Pimoroni
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.