qmk_firmware/docs/_summary.md

• Getting started

  • QMK Introduction
  • Install Build Tools
    • Alternative: Vagrant Guide
  • Build/Compile instructions
  • How to Use Github

• FAQ

  • General FAQ
  • Build/Compile QMK
  • Debugging/Troubleshooting QMK
  • Keymap

• Features

  • Layouts
  • Common Shortcuts
  • Backlight
  • Bootmagic
  • Dynamic Macros
  • Key Lock
  • Leader Key
  • Macros
  • Mouse keys
  • PS2 Mouse
  • Space Cadet
  • Tap Dance
  • Audio
  • Thermal Printer
  • Stenography
  • Unicode
  • Terminal

• Reference

  • Glossary
  • Keymap overview
  • Keycodes
    • Basic
    • Quantum
    • Backlight
    • Bluetooth
    • Bootmagic
    • Layer Switching
    • Mod+Key
    • Mod Tap
    • One Shot Keys
    • Shifted Keys
    • Stenography
    • RGB Light
    • Thermal Printer
    • US ANSI Shifted Keys
  • The config.h File
  • Customizing Functionality
  • Documentation Best Practices
  • Unit Testing

• For Makers and Modders

  • Adding a keyboard to QMK
  • Adding features to QMK
  • Hand Wiring Guide
  • ISP flashing guide
  • Modding your keyboard
  • Porting your keyboard to QMK

• For a Deeper Understanding

  • How Keyboards Work
  • Understanding QMK

• Other Topics

  • Using Eclipse with QMK