dfa73a8cca
* Added for keycodes, pin numbers, and code snippets. Mostly in tables. * Enhance documentation readability * Make automated spell checking easier - aspell automatically ignores these snippets * fix invalid markdown table in mouse_keys.md |
||
|---|---|---|
| .. | ||
| ja | ||
| ptBR | ||
| adns9800.md | ||
| ble_hid.md | ||
| boot.md | ||
| capsword.md | ||
| cg_swap.md | ||
| combos.md | ||
| config_and_keymap.md | ||
| contributing.md | ||
| debugging.md | ||
| easypoint.md | ||
| encoder.md | ||
| extension_statusled.md | ||
| extensions.md | ||
| flashing.md | ||
| Getting_Started.md | ||
| handwiring.md | ||
| international.md | ||
| keycodes.md | ||
| keys.md | ||
| kmkpython_vs_circuitpython.md | ||
| layers.md | ||
| led.md | ||
| lock_status.md | ||
| media_keys.md | ||
| midi.md | ||
| modtap.md | ||
| modules.md | ||
| mouse_keys.md | ||
| Officially_Supported_Microcontrollers.md | ||
| oneshot.md | ||
| pimoroni_trackball.md | ||
| pins56.jpg | ||
| porting_to_kmk.md | ||
| power.md | ||
| README.md | ||
| rgb.md | ||
| scanners.md | ||
| sequences.md | ||
| split_keyboards.md | ||
| support.md | ||
| tapdance.md | ||
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.pyfile 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
- ModTap: 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.
- 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.