docs/_summary.md

   1 * [Getting started](README.md)
   2   * [QMK Introduction](getting_started_introduction.md)
   3   * [Install Build Tools](getting_started_build_tools.md)
   4     * Alternative: [Vagrant Guide](getting_started_vagrant_guide.md)
   5   * [Build/Compile instructions](getting_started_make_guide.md)
   6   * [Contributing to QMK](contributing.md)
   7   * [How to Use Github](getting_started_github.md)
   8
   9 * [FAQ](faq.md)
  10   * [General FAQ](faq_general.md)
  11   * [Build/Compile QMK](faq_build.md)
  12   * [Debugging/Troubleshooting QMK](faq_debug.md)
  13   * [Keymap](faq_keymap.md)
  14
  15 * [Hardware](hardware.md)
  16   * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
  17   * [AVR Processors](hardware_avr.md)
  18   * ARM Processors (TBD)
  19   * [Drivers](hardware_drivers.md)
  20
  21 * [Features](features.md)
  22   * [Advanced Keycodes](feature_advanced_keycodes.md)
  23   * [Audio](feature_audio.md)
  24   * [Backlight](feature_backlight.md)
  25   * [Bootmagic](feature_bootmagic.md)
  26   * [Dynamic Macros](feature_dynamic_macros.md)
  27   * [Key Lock](feature_key_lock.md)
  28   * [Layouts](feature_layouts.md)
  29   * [Leader Key](feature_leader_key.md)
  30   * [Macros](feature_macros.md)
  31   * [Mouse keys](feature_mouse_keys.md)
  32   * [Pointing Device](feature_pointing_device.md)
  33   * [PS2 Mouse](feature_ps2_mouse.md)
  34   * [Space Cadet](feature_space_cadet.md)
  35   * [Stenography](feature_stenography.md)
  36   * [Tap Dance](feature_tap_dance.md)
  37   * [Terminal](feature_terminal.md)
  38   * [Thermal Printer](feature_thermal_printer.md)
  39   * [Unicode](feature_unicode.md)
  40   * [Userspace](feature_userspace.md)
  41
  42 * Reference
  43   * [Config Options](config_options.md)
  44   * [Customizing Functionality](custom_quantum_functions.md)
  45   * [Documentation Best Practices](documentation_best_practices.md)
  46   * [Documentation Templates](documentation_templates.md)
  47   * [Glossary](glossary.md)
  48   * [Keymap overview](keymap.md)
  49   * [Keycodes](keycodes.md)
  50     * [Backlight](feature_backlight.md#backlight-keycodes)
  51     * [Basic](keycodes_basic.md)
  52     * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
  53     * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
  54     * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)
  55     * [Mod+Key](feature_common_shortcuts.md#modifier-keys)
  56     * [Mod Tap](feature_common_shortcuts.md#mod-tap)
  57     * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)
  58     * [Quantum](quantum_keycodes.md)
  59     * [RGB Light](feature_rgblight.md#rgblight-keycodes)
  60     * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
  61     * [Stenography](feature_stenography.md#keycode-reference)
  62     * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
  63     * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
  64   * [Unit Testing](unit_testing.md)
  65
  66 * For Makers and Modders
  67   * [Hand Wiring Guide](hand_wiring.md)
  68   * [ISP flashing guide](isp_flashing_guide.md)
  69   * [Modding your keyboard](modding_your_keyboard.md)
  70
  71 * For a Deeper Understanding
  72   * [How Keyboards Work](how_keyboards_work.md)
  73   * [Understanding QMK](understanding_qmk.md)
  74
  75 * Other Topics
  76   * [Using Eclipse with QMK](eclipse.md)