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 * [Features](features.md)
  16   * [Layouts](feature_layouts.md)
  17   * [Common Shortcuts](feature_common_shortcuts.md)
  18   * [Backlight](feature_backlight.md)
  19   * [Bootmagic](feature_bootmagic.md)
  20   * [Dynamic Macros](dynamic_macros.md)
  21   * [Key Lock](key_lock.md)
  22   * [Leader Key](feature_leader_key.md)
  23   * [Macros](macros.md)
  24   * [Mouse keys](mouse_keys.md)
  25   * [Pointing Device](feature_pointing_device.md)
  26   * [PS2 Mouse](feature_ps2_mouse.md)
  27   * [Space Cadet](space_cadet_shift.md)
  28   * [Tap Dance](tap_dance.md)
  29   * [Audio](feature_audio.md)
  30   * [Thermal Printer](feature_thermal_printer.md)
  31   * [Stenography](stenography.md)
  32   * [Unicode](unicode.md)
  33   * [Terminal](feature_terminal.md)
  34
  35 * Reference
  36   * [Glossary](glossary.md)
  37   * [Keymap overview](keymap.md)
  38   * [Keycodes](keycodes.md)
  39     * [Basic](keycodes_basic.md)
  40     * [Quantum](quantum_keycodes.md)
  41     * [Backlight](feature_backlight.md#backlight-keycodes)
  42     * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
  43     * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
  44     * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)
  45     * [Mod+Key](feature_common_shortcuts.md#modifier-keys)
  46     * [Mod Tap](feature_common_shortcuts.md#mod-tap)
  47     * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)
  48     * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
  49     * [Stenography](stenography.md#keycode-reference)
  50     * [RGB Light](feature_rgblight.md#rgblight-keycodes)
  51     * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
  52     * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
  53   * [The `config.h` File](config_options.md)
  54   * [Customizing Functionality](custom_quantum_functions.md)
  55   * [Documentation Best Practices](documentation_best_practices.md)
  56   * [Documentation Templates](documentation_templates.md)
  57   * [Unit Testing](unit_testing.md)
  58
  59 * For Makers and Modders
  60   * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
  61   * [Hand Wiring Guide](hand_wiring.md)
  62   * [ISP flashing guide](isp_flashing_guide.md)
  63   * [Modding your keyboard](modding_your_keyboard.md)
  64   * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
  65
  66 * For a Deeper Understanding
  67   * [How Keyboards Work](how_keyboards_work.md)
  68   * [Understanding QMK](understanding_qmk.md)
  69
  70 * Other Topics
  71   * [Using Eclipse with QMK](eclipse.md)