qmk-firmware/docs/_summary.md

• Tutorial

  • Introduction
  • Setup
  • Building Your First Firmware
  • Flashing Firmware
  • Getting Help/Support
  • Building With GitHub Userspace
  • Other Resources
  • Syllabus

• FAQs

  • General FAQ
  • Build/Compile QMK
  • Troubleshooting QMK
  • Debugging QMK
  • Keymap FAQ
  • Squeezing Space from AVR
  • Glossary

• Configurator

  • Overview
  • Step by Step
  • Troubleshooting
  • Architecture
  • QMK API
    • Overview
    • API Documentation
    • Keyboard Support
    • Adding Default Keymaps

• CLI

  • Overview
  • Configuration
  • Commands
  • Tab Completion

• Using QMK

  • Guides

    • Customizing Functionality
    • Driver Installation with Zadig
    • Keymap Overview
    • Development Environments
      • Docker Guide
      • Vagrant Guide
    • Flashing
      • Flashing
      • Flashing ATmega32A (ps2avrgb)
    • IDEs
      • Using Eclipse with QMK
      • Using VSCode with QMK
    • Git Best Practices
      • Introduction
      • Your Fork
      • Merge Conflicts
      • Fixing Your Branch

  • Simple Keycodes

    • Full List
    • Basic Keycodes
    • Language-Specific Keycodes
    • Modifier Keys
    • Quantum Keycodes
    • Magic Keycodes

  • Advanced Keycodes

    • Command
    • Dynamic Macros
    • Grave Escape
    • Leader Key
    • Mod-Tap
    • Macros
    • Mouse Keys
    • Programmable Button
    • Space Cadet Shift
    • US ANSI Shifted Keys

  • Software Features

    • Auto Shift
    • Autocorrect
    • Caps Word
    • Combos
    • Debounce API
    • EEPROM
    • Key Lock
    • Key Overrides
    • Layers
    • One Shot Keys
    • Raw HID
    • Secure
    • Send String
    • Sequencer
    • Swap Hands
    • Tap Dance
    • Tap-Hold Configuration
    • Unicode
    • Userspace
    • WPM Calculation

  • Hardware Features

    • Displays
      • Quantum Painter
      • HD44780 LCD Driver
      • ST7565 LCD Driver
      • OLED Driver
    • Lighting
      • Backlight
      • LED Matrix
      • RGB Lighting
      • RGB Matrix
    • Audio
    • Bluetooth
    • Bootmagic Lite
    • Converters
    • Custom Matrix
    • Digitizer
    • DIP Switch
    • Encoders
    • Haptic Feedback
    • Joystick
    • LED Indicators
    • MIDI
    • Pointing Device
    • PS/2 Mouse
    • Split Keyboard
    • Stenography
    • Velocikey

  • Keyboard Building

    • Easy Maker for One Offs
    • Porting Keyboards
    • Hand Wiring Guide
    • ISP Flashing Guide

• Developing QMK

  • PR Checklist

  • Breaking Changes

    • Overview
    • My Pull Request Was Flagged
    • Most Recent ChangeLog
    • Past Breaking Changes

  • C Development

    • ARM Debugging Guide
    • Coding Conventions
    • Compatible Microcontrollers
    • Drivers
      • ADC Driver
      • Audio Driver
      • I2C Driver
      • SPI Driver
      • WS2812 Driver
      • EEPROM Driver
      • Flash Driver
      • 'serial' Driver
      • UART Driver
    • GPIO Controls
    • Keyboard Guidelines

  • Python Development

    • Coding Conventions
    • QMK CLI Development

  • Configurator Development

    • QMK API
      • Development Environment
      • Architecture Overview

  • Hardware Platform Development

    • Arm/ChibiOS
      • Selecting an MCU
      • Early initialization
      • Raspberry Pi RP2040
      • Proton C
      • WeAct Blackpill F4x1

  • QMK Reference

    • Contributing to QMK
    • Translating the QMK Docs
    • Config Options
    • Data Driven Configuration
    • Make Documentation
    • Documentation Best Practices
    • Documentation Templates
    • Community Layouts
    • Unit Testing
    • Useful Functions
    • info.json Format

  • For a Deeper Understanding

    • How Keyboards Work
    • How a Matrix Works
    • Understanding QMK

  • QMK Internals (In Progress)

    • Defines
    • Input Callback Reg
    • Midi Device
    • Midi Device Setup Process
    • Midi Util
    • Send Functions
    • Sysex Tools