qmk_firmware/docs/_summary.md

* [Getting Started](README.md)
  * [QMK Introduction](getting_started_introduction.md)
  * [Install Build Tools](getting_started_build_tools.md)
    * Alternative: [Vagrant Guide](getting_started_vagrant.md)
  * [Build/Compile Instructions](getting_started_make_guide.md)
  * [Flashing Firmware](flashing.md)
  * [Contributing to QMK](contributing.md)
  * [How to Use Github](getting_started_github.md)
  * [Getting Help](getting_started_getting_help.md)

* [Complete Newbs Guide](newbs.md)
  * [Getting Started](newbs_getting_started.md)
  * [Building Your First Firmware](newbs_building_firmware.md)
  * [Flashing Firmware](newbs_flashing.md)
  * [Testing and Debugging](newbs_testing_debugging.md)

* [FAQ](faq.md)
  * [General FAQ](faq_general.md)
  * [Build/Compile QMK](faq_build.md)
  * [Debugging/Troubleshooting QMK](faq_debug.md)
  * [Keymap](faq_keymap.md)

* [Hardware](hardware.md)
  * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
  * [AVR Processors](hardware_avr.md)
  * ARM Processors (TBD)
  * [Drivers](hardware_drivers.md)

* [Features](features.md)
  * [Advanced Keycodes](feature_advanced_keycodes.md)
  * [Audio](feature_audio.md)
  * [Auto Shift](feature_auto_shift.md)
  * [Backlight](feature_backlight.md)
  * [Bootmagic](feature_bootmagic.md)
  * [Command](feature_command.md)
  * [Dynamic Macros](feature_dynamic_macros.md)
  * [Grave Escape](feature_grave_esc.md)
  * [Key Lock](feature_key_lock.md)
  * [Layouts](feature_layouts.md)
  * [Leader Key](feature_leader_key.md)
  * [Macros](feature_macros.md)
  * [Mouse Keys](feature_mouse_keys.md)
  * [Pointing Device](feature_pointing_device.md)
  * [PS/2 Mouse](feature_ps2_mouse.md)
  * [RGB Lighting](feature_rgblight.md)
  * [Space Cadet](feature_space_cadet.md)
  * [Stenography](feature_stenography.md)
  * [Swap Hands](feature_swap_hands.md)
  * [Tap Dance](feature_tap_dance.md)
  * [Terminal](feature_terminal.md)
  * [Thermal Printer](feature_thermal_printer.md)
  * [Unicode](feature_unicode.md)
  * [Userspace](feature_userspace.md)

* [Keycodes](keycodes.md)
  * [Basic](keycodes_basic.md)
  * [Quantum](quantum_keycodes.md)
  * [Audio](feature_audio.md#audio-keycodes)
  * [Backlight](feature_backlight.md#backlight-keycodes)
  * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
  * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
  * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
  * [Mod+Key](feature_advanced_keycodes.md#modifier-keys)
  * [Mod Tap](feature_advanced_keycodes.md#mod-tap)
  * [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys)
  * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
  * [RGB Light](feature_rgblight.md#rgblight-keycodes)
  * [RGB Matrix](feature_rgb_matrix.md#keycodes)
  * [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes)
  * [Stenography](feature_stenography.md#keycode-reference)
  * [Swap Hands](feature_swap_hands.md#swap-keycodes)
  * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
  * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)

* Reference
  * [Config Options](config_options.md)
  * [Customizing Functionality](custom_quantum_functions.md)
  * [Documentation Best Practices](documentation_best_practices.md)
  * [Documentation Templates](documentation_templates.md)
  * [Glossary](reference_glossary.md)
  * [Keymap Overview](keymap.md)
  * [Unit Testing](unit_testing.md)

* For Makers and Modders
  * [Hand Wiring Guide](hand_wire.md)
  * [ISP Flashing Guide](isp_flashing_guide.md)

* For a Deeper Understanding
  * [How Keyboards Work](how_keyboards_work.md)
  * [Understanding QMK](understanding_qmk.md)

* Other Topics
  * [Using Eclipse with QMK](eclipse.md)

* QMK Internals (In Progress)
  * [Defines](internals_defines.md)
  * [Input Callback Reg](internals_input_callback_reg.md)
  * [Midi Device](internals_midi_device.md)
  * [Midi Device Setup Process](internals_midi_device_setup_process.md)
  * [Midi Util](internals_midi_util.md)
  * [Send Functions](internals_send_functions.md)
  * [Sysex Tools](internals_sysex_tools.md)
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [Getting Started](README.md)`
Overhaul the Getting Started section and add a FAQ section 2017-08-06 03:54:34 +00:00			`* [QMK Introduction](getting_started_introduction.md)`
			`* [Install Build Tools](getting_started_build_tools.md)`
Fix internal links in docs/ (#2080) One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names. 2017-11-30 18:18:01 +00:00			`* Alternative: [Vagrant Guide](getting_started_vagrant.md)`
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [Build/Compile Instructions](getting_started_make_guide.md)`
Add a newbie guide for people completely new to QMK (#2480) 2018-03-06 22:37:48 +00:00			`* [Flashing Firmware](flashing.md)`
Fix the presentation of the contribution guide 2017-10-11 19:18:53 +00:00			`* [Contributing to QMK](contributing.md)`
Overhaul the Getting Started section and add a FAQ section 2017-08-06 03:54:34 +00:00			`* [How to Use Github](getting_started_github.md)`
Add a newbie guide for people completely new to QMK (#2480) 2018-03-06 22:37:48 +00:00			`* [Getting Help](getting_started_getting_help.md)`

			`* [Complete Newbs Guide](newbs.md)`
			`* [Getting Started](newbs_getting_started.md)`
			`* [Building Your First Firmware](newbs_building_firmware.md)`
			`* [Flashing Firmware](newbs_flashing.md)`
			`* [Testing and Debugging](newbs_testing_debugging.md)`
Overhaul the Getting Started section and add a FAQ section 2017-08-06 03:54:34 +00:00
			`* [FAQ](faq.md)`
			`* [General FAQ](faq_general.md)`
			`* [Build/Compile QMK](faq_build.md)`
			`* [Debugging/Troubleshooting QMK](faq_debug.md)`
			`* [Keymap](faq_keymap.md)`
convert docs to lowercase and underscores 2017-06-10 18:58:55 +00:00
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Hardware](hardware.md)`
			`* [Keyboard Guidelines](hardware_keyboard_guidelines.md)`
			`* [AVR Processors](hardware_avr.md)`
			`* ARM Processors (TBD)`
			`* [Drivers](hardware_drivers.md)`

Update _summary.md 2017-07-17 19:01:33 +00:00			`* [Features](features.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Advanced Keycodes](feature_advanced_keycodes.md)`
			`* [Audio](feature_audio.md)`
Fixed various feature links 2017-10-27 15:05:51 +00:00			`* [Auto Shift](feature_auto_shift.md)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [Backlight](feature_backlight.md)`
			`* [Bootmagic](feature_bootmagic.md)`
More thoroughly document Bootmagic and Command (#2455) 2018-03-02 17:21:03 +00:00			`* [Command](feature_command.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Dynamic Macros](feature_dynamic_macros.md)`
fix link for grave escape in docs 2017-12-03 11:49:11 +00:00			`* [Grave Escape](feature_grave_esc.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Key Lock](feature_key_lock.md)`
			`* [Layouts](feature_layouts.md)`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [Leader Key](feature_leader_key.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Macros](feature_macros.md)`
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [Mouse Keys](feature_mouse_keys.md)`
Added Dichotemy Keyboard, updated docs for Pointing Device (#1817) * Added Dichotemy Keyboard, updated docs for Pointing Device * Updated readme * Updated mouse report pointer in pointing_device.c 2017-10-10 17:07:59 +00:00			`* [Pointing Device](feature_pointing_device.md)`
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [PS/2 Mouse](feature_ps2_mouse.md)`
Fixed various feature links 2017-10-27 15:05:51 +00:00			`* [RGB Lighting](feature_rgblight.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Space Cadet](feature_space_cadet.md)`
			`* [Stenography](feature_stenography.md)`
Add back docs for hand-swapping feature. 2018-03-07 08:03:51 +00:00			`* [Swap Hands](feature_swap_hands.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Tap Dance](feature_tap_dance.md)`
Updates send_string functionality, adds terminal feature (#1657) * implement basic terminal stuff * modify send_string to read normal strings too * add files bc yeah. working pgm detected * pgm detection apparently not working * adds send string keycodes, additional keycode support in send string * implement arguments * [terminal] add help command * [terminal] adds keycode and keymap functions * [terminal] adds nop.h, documentation * update macro docs 2017-09-12 04:43:10 +00:00			`* [Terminal](feature_terminal.md)`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Thermal Printer](feature_thermal_printer.md)`
			`* [Unicode](feature_unicode.md)`
			`* [Userspace](feature_userspace.md)`
convert docs to lowercase and underscores 2017-06-10 18:58:55 +00:00
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [Keycodes](keycodes.md)`
			`* [Basic](keycodes_basic.md)`
Overhaul to keycode related docs * Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section 2018-07-12 17:11:07 +00:00			`* [Quantum](quantum_keycodes.md)`
			`* [Audio](feature_audio.md#audio-keycodes)`
			`* [Backlight](feature_backlight.md#backlight-keycodes)`
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)`
Overhaul to keycode related docs * Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section 2018-07-12 17:11:07 +00:00			`* [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)`
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)`
			`* [Mod+Key](feature_advanced_keycodes.md#modifier-keys)`
			`* [Mod Tap](feature_advanced_keycodes.md#mod-tap)`
Overhaul to keycode related docs * Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section 2018-07-12 17:11:07 +00:00			`* [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys)`
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)`
			`* [RGB Light](feature_rgblight.md#rgblight-keycodes)`
Overhaul to keycode related docs * Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section 2018-07-12 17:11:07 +00:00			`* [RGB Matrix](feature_rgb_matrix.md#keycodes)`
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes)`
			`* [Stenography](feature_stenography.md#keycode-reference)`
Overhaul to keycode related docs * Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section 2018-07-12 17:11:07 +00:00			`* [Swap Hands](feature_swap_hands.md#swap-keycodes)`
Move keycodes to their own section 2017-11-10 20:35:51 +00:00			`* [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)`
			`* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)`

restructure summary 2017-06-29 14:35:09 +00:00			`* Reference`
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			`* [Config Options](config_options.md)`
			`* [Customizing Functionality](custom_quantum_functions.md)`
			`* [Documentation Best Practices](documentation_best_practices.md)`
			`* [Documentation Templates](documentation_templates.md)`
Disable the glossary linking to fix #2498 (#2499) 2018-03-08 18:31:08 +00:00			`* [Glossary](reference_glossary.md)`
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [Keymap Overview](keymap.md)`
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* [Unit Testing](unit_testing.md)`
Link to steno docs from summary page. 2017-07-27 18:59:17 +00:00
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* For Makers and Modders`
update hand wiring link 2017-10-31 17:38:57 +00:00			`* [Hand Wiring Guide](hand_wire.md)`
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`* [ISP Flashing Guide](isp_flashing_guide.md)`
update the summary 2017-07-03 19:30:26 +00:00
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* For a Deeper Understanding`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [How Keyboards Work](how_keyboards_work.md)`
update the summary 2017-07-03 19:30:26 +00:00			`* [Understanding QMK](understanding_qmk.md)`
Link to steno docs from summary page. 2017-07-27 18:59:17 +00:00
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* Other Topics`
restructure summary 2017-06-29 14:35:09 +00:00			`* [Using Eclipse with QMK](eclipse.md)`
Generate API docs from source code comments (#2491) * Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly 2018-03-22 06:50:38 +00:00
rename api docs to internals 2018-03-26 18:24:30 +00:00			`* QMK Internals (In Progress)`
			`* [Defines](internals_defines.md)`
			`* [Input Callback Reg](internals_input_callback_reg.md)`
			`* [Midi Device](internals_midi_device.md)`
			`* [Midi Device Setup Process](internals_midi_device_setup_process.md)`
			`* [Midi Util](internals_midi_util.md)`
			`* [Send Functions](internals_send_functions.md)`
			`* [Sysex Tools](internals_sysex_tools.md)`