qmk_firmware/docs/_summary.md

• Getting Started

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

• FAQ

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

• Hardware

  • Keyboard Guidelines
  • AVR Processors
  • ARM Processors (TBD)
  • Drivers

• Features

  • Advanced Keycodes
  • Audio
  • Auto Shift
  • Backlight
  • Bootmagic
  • Dynamic Macros
  • Grave Escape
  • Key Lock
  • Layouts
  • Leader Key
  • Macros
  • Mouse Keys
  • Pointing Device
  • PS/2 Mouse
  • RGB Lighting
  • Space Cadet
  • Stenography
  • Tap Dance
  • Terminal
  • Thermal Printer
  • Unicode
  • Userspace

• Keycodes

  • Backlight
  • Basic
  • Bluetooth
  • Bootmagic
  • Layer Switching
  • Mod+Key
  • Mod Tap
  • One Shot Keys
  • Quantum
  • RGB Light
  • Shifted Keys
  • Stenography
  • Thermal Printer
  • US ANSI Shifted Keys

• Reference

  • Config Options
  • Customizing Functionality
  • Documentation Best Practices
  • Documentation Templates
  • Glossary
  • Keymap Overview
  • Unit Testing

• For Makers and Modders

  • Hand Wiring Guide
  • ISP Flashing Guide

• For a Deeper Understanding

  • How Keyboards Work
  • Understanding QMK

• Other Topics

  • Using Eclipse with QMK