logologo
Guide
Documentation
API doc
main
v0.8
v0.7.8
Guide
Documentation
API doc
main
v0.8
v0.7.8
logologo
RMK introduction

User Guide

Overview
Beginners Guide
Cloud compilation
Local compilation
Flash the firmware
FAQ
Real world examples

Features

Keyboard Configuration

Keyboard and matrix
Layout
Wireless/Bluetooth
Light
Split keyboard
Behavior
Storage
Input devices
RMK Internal Configuration
Appendix

Keymap Configuration

Keyboard Macros
Keycodes
Special Characters and Unicode
Special Keys
Layers
Split keyboard
Wireless
Vial support
Low-power
Storage
USB Logging
Use Rust
Binary size

Input Devices

Rotary encoders
Joysticks

Development

Contributing
Roadmap
  • rmk-ble-keyboard
  • dactyl-lynx-rmk
  • Show your keyboard!

Real world examples#

This pages contains real world examples of RMK keyboards.

rmk-ble-keyboard#

A BLE/USB dual-mode GH60 keyboard using Ebyte's E73 nRF52840 module.

rmk-ble-keyboard

dactyl-lynx-rmk#

Show your keyboard!#

If you're using RMK to build your keyboard, feel free to open a PR adding your project to this page!

Previous PageFAQ
Next PageKeyboard Configuration
ON THIS PAGE
  • rmk-ble-keyboard
  • dactyl-lynx-rmk
  • Show your keyboard!