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

Getting Started

Introduction
Supported Hardwares
Real World Examples
FAQ

User Guide

Guide Overview

Creating Firmware

Cloud compilation
Local compilation
Flashing Firmware

Migration Guide

From v0.6 to v0.7
From v0.7 to v0.8

Features

Matrix
Layers
Wireless
Configuration
Low Power
Split keyboard
Vial support
USB Logging
Storage
Use Rust
Controller Support
Input Device
Binary size

Configuration

Keyboard Device
Keyboard Matrix
Layout

Keymap Configuration

Keyboard Macros
Keycodes
Special Characters and Unicode
Special Keys
Light
Behavior
Split keyboard
Wireless/Bluetooth
Storage
Host Configuration
RMK Internal Configuration

Input Device

Rotary encoders
Joysticks
PMW3610 Optical Mouse Sensor
Appendix

Development

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

Real World Examples#

This page 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#

dactyl-lynx-rmk

sessile#

Sessile is an exploration of "minimal" finger travel. You can also read its circuitous origin story.

sessile

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 PageSupported Hardwares
Next PageFAQ
ON THIS PAGE
  • rmk-ble-keyboard
  • dactyl-lynx-rmk
  • sessile
  • Show your keyboard!