docs/_summary.md

   1 * [Complete Newbs Guide](newbs.md)
   2   * [Getting Started](newbs_getting_started.md)
   3   * [Building Your First Firmware](newbs_building_firmware.md)
   4   * [Flashing Firmware](newbs_flashing.md)
   5   * [Testing and Debugging](newbs_testing_debugging.md)
   6   * [Git Best Practices](newbs_best_practices.md)
   7   * [Learning Resources](newbs_learn_more_resources.md)
   8
   9 * [QMK Basics](README.md)
  10   * [QMK Introduction](getting_started_introduction.md)
  11   * [QMK CLI](cli.md)
  12   * [QMK CLI Config](cli_configuration.md)
  13   * [Contributing to QMK](contributing.md)
  14   * [How to Use Github](getting_started_github.md)
  15   * [Getting Help](getting_started_getting_help.md)
  16
  17 * [Breaking Changes](breaking_changes.md)
  18   * [2019 Aug 30](ChangeLog/20190830.md)
  19
  20 * [FAQ](faq.md)
  21   * [General FAQ](faq_general.md)
  22   * [Build/Compile QMK](faq_build.md)
  23   * [Debugging/Troubleshooting QMK](faq_debug.md)
  24   * [Keymap](faq_keymap.md)
  25   * [Driver Installation with Zadig](driver_installation_zadig.md)
  26
  27 * Detailed Guides
  28   * [Install Build Tools](getting_started_build_tools.md)
  29   * [Vagrant Guide](getting_started_vagrant.md)
  30   * [Build/Compile Instructions](getting_started_make_guide.md)
  31   * [Flashing Firmware](flashing.md)
  32   * [Customizing Functionality](custom_quantum_functions.md)
  33   * [Keymap Overview](keymap.md)
  34
  35 * [Hardware](hardware.md)
  36   * [AVR Processors](hardware_avr.md)
  37   * [Drivers](hardware_drivers.md)
  38
  39 * Reference
  40   * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
  41   * [Config Options](config_options.md)
  42   * [Keycodes](keycodes.md)
  43   * [Coding Conventions - C](coding_conventions_c.md)
  44   * [Coding Conventions - Python](coding_conventions_python.md)
  45   * [Documentation Best Practices](documentation_best_practices.md)
  46   * [Documentation Templates](documentation_templates.md)
  47   * [Glossary](reference_glossary.md)
  48   * [Unit Testing](unit_testing.md)
  49   * [Useful Functions](ref_functions.md)
  50   * [Configurator Support](reference_configurator_support.md)
  51   * [info.json Format](reference_info_json.md)
  52   * [Python CLI Development](cli_development.md)
  53
  54 * [Features](features.md)
  55   * [Basic Keycodes](keycodes_basic.md)
  56   * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
  57   * [Quantum Keycodes](quantum_keycodes.md)
  58   * [Advanced Keycodes](feature_advanced_keycodes.md)
  59   * [Audio](feature_audio.md)
  60   * [Auto Shift](feature_auto_shift.md)
  61   * [Backlight](feature_backlight.md)
  62   * [Bluetooth](feature_bluetooth.md)
  63   * [Bootmagic](feature_bootmagic.md)
  64   * [Combos](feature_combo.md)
  65   * [Command](feature_command.md)
  66   * [Debounce API](feature_debounce_type.md)
  67   * [DIP Switch](feature_dip_switch.md)
  68   * [Dynamic Macros](feature_dynamic_macros.md)
  69   * [Encoders](feature_encoders.md)
  70   * [Grave Escape](feature_grave_esc.md)
  71   * [Haptic Feedback](feature_haptic_feedback.md)
  72   * [HD44780 LCD Controller](feature_hd44780.md)
  73   * [Key Lock](feature_key_lock.md)
  74   * [Layouts](feature_layouts.md)
  75   * [Leader Key](feature_leader_key.md)
  76   * [LED Matrix](feature_led_matrix.md)
  77   * [Macros](feature_macros.md)
  78   * [Mouse Keys](feature_mouse_keys.md)
  79   * [OLED Driver](feature_oled_driver.md)
  80   * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
  81   * [Pointing Device](feature_pointing_device.md)
  82   * [PS/2 Mouse](feature_ps2_mouse.md)
  83   * [RGB Lighting](feature_rgblight.md)
  84   * [RGB Matrix](feature_rgb_matrix.md)
  85   * [Space Cadet](feature_space_cadet.md)
  86   * [Split Keyboard](feature_split_keyboard.md)
  87   * [Stenography](feature_stenography.md)
  88   * [Swap Hands](feature_swap_hands.md)
  89   * [Tap Dance](feature_tap_dance.md)
  90   * [Terminal](feature_terminal.md)
  91   * [Thermal Printer](feature_thermal_printer.md)
  92   * [Unicode](feature_unicode.md)
  93   * [Userspace](feature_userspace.md)
  94   * [Velocikey](feature_velocikey.md)
  95
  96 * For Makers and Modders
  97   * [Hand Wiring Guide](hand_wire.md)
  98   * [ISP Flashing Guide](isp_flashing_guide.md)
  99   * [ARM Debugging Guide](arm_debugging.md)
 100   * [I2C Driver](i2c_driver.md)
 101   * [WS2812 Driver](ws2812_driver.md)
 102   * [GPIO Controls](internals_gpio_control.md)
 103   * [Proton C Conversion](proton_c_conversion.md)
 104
 105 * For a Deeper Understanding
 106   * [How Keyboards Work](how_keyboards_work.md)
 107   * [Understanding QMK](understanding_qmk.md)
 108
 109 * Other Topics
 110   * [Using Eclipse with QMK](other_eclipse.md)
 111   * [Using VSCode with QMK](other_vscode.md)
 112   * [Support](support.md)
 113   * [How to add translations](translating.md)
 114
 115 * QMK Internals (In Progress)
 116   * [Defines](internals_defines.md)
 117   * [Input Callback Reg](internals_input_callback_reg.md)
 118   * [Midi Device](internals_midi_device.md)
 119   * [Midi Device Setup Process](internals_midi_device_setup_process.md)
 120   * [Midi Util](internals_midi_util.md)
 121   * [Send Functions](internals_send_functions.md)
 122   * [Sysex Tools](internals_sysex_tools.md)