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_guide.md)
  * [Build/Compile instructions](getting_started_make_guide.md)
  * [How to Use Github](getting_started_github.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)

* [Features](features.md)
  * [Layouts](feature_layouts.md)
  * [Common Shortcuts](feature_common_shortcuts.md)
  * [Backlight](feature_backlight.md)
  * [Bootmagic](feature_bootmagic.md)
  * [Dynamic Macros](dynamic_macros.md)
  * [Key Lock](key_lock.md)
  * [Leader Key](feature_leader_key.md)
  * [Macros](macros.md)
  * [Mouse keys](mouse_keys.md)
  * [PS2 Mouse](feature_ps2_mouse.md)
  * [Space Cadet](space_cadet_shift.md)
  * [Tap Dance](tap_dance.md)
  * [Audio](feature_audio.md)
  * [Thermal Printer](feature_thermal_printer.md)
  * [Stenography](stenography.md)
  * [Unicode](unicode.md)

* Reference
  * [Glossary](glossary.md)
  * [Keymap overview](keymap.md)
  * [Keycodes](keycodes.md)
    * [Basic](keycodes_basic.md)
    * [Quantum](quantum_keycodes.md)
    * [Backlight](feature_backlight.md#backlight-keycodes)
    * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
    * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
    * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)
    * [Mod+Key](feature_common_shortcuts.md#modifier-keys)
    * [Mod Tap](feature_common_shortcuts.md#mod-tap)
    * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)
    * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
    * [Stenography](stenography.md#keycode-reference)
    * [RGB Light](feature_rgblight.md#rgblight-keycodes)
    * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
    * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
  * [The `config.h` File](config_options.md)
  * [Customizing Functionality](custom_quantum_functions.md)
  * [Documentation Best Practices](documentation_best_practices.md)
  * [Unit Testing](unit_testing.md)

* For Makers and Modders
  * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
  * [Adding features to QMK](adding_features_to_qmk.md)
  * [Hand Wiring Guide](hand_wiring.md)
  * [ISP flashing guide](isp_flashing_guide.md)
  * [Modding your keyboard](modding_your_keyboard.md)
  * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.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)
Link to steno docs from summary page. 2017-07-27 18:59:17 +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)`
			`* Alternative: [Vagrant Guide](getting_started_vagrant_guide.md)`
			`* [Build/Compile instructions](getting_started_make_guide.md)`
			`* [How to Use Github](getting_started_github.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)`
convert docs to lowercase and underscores 2017-06-10 18:58:55 +00:00
Update _summary.md 2017-07-17 19:01:33 +00:00			`* [Features](features.md)`
Creates a layouts/ folder for keymaps shared between keyboards (#1609) * include variables and .h files as pp directives * start layout compilation * split ergodoxes up * don't compile all layouts for everything * might seg fault * reset layouts variable * actually reset layouts * include rules.mk instead * remove includes from rules.mk * update variable setting * load visualizer from path * adds some more examples * adds more layouts * more boards added * more boards added * adds documentation for layouts * use lowercase names for LAYOUT_ * add layout.json files for each layout * add community folder, default keymaps for layouts * touch-up default layouts * touch-up layouts, some keyboard rules.mk * update documentation for layouts * fix up serial/i2c switches 2017-08-24 02:29:07 +00:00			`* [Layouts](feature_layouts.md)`
rework key_functions into feature_common_shortcuts 2017-08-06 16:36:15 +00:00			`* [Common Shortcuts](feature_common_shortcuts.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)`
			`* [Dynamic Macros](dynamic_macros.md)`
			`* [Key Lock](key_lock.md)`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [Leader Key](feature_leader_key.md)`
restructure summary 2017-06-29 14:35:09 +00:00			`* [Macros](macros.md)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [Mouse keys](mouse_keys.md)`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [PS2 Mouse](feature_ps2_mouse.md)`
restructure summary 2017-06-29 14:35:09 +00:00			`* [Space Cadet](space_cadet_shift.md)`
			`* [Tap Dance](tap_dance.md)`
adds audio docs to summary 2017-08-18 17:57:57 +00:00			`* [Audio](feature_audio.md)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [Thermal Printer](feature_thermal_printer.md)`
Link to steno docs from summary page. 2017-07-27 18:59:17 +00:00			`* [Stenography](stenography.md)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [Unicode](unicode.md)`
convert docs to lowercase and underscores 2017-06-10 18:58:55 +00:00
restructure summary 2017-06-29 14:35:09 +00:00			`* Reference`
start glossary 2017-06-30 02:12:24 +00:00			`* [Glossary](glossary.md)`
restructure summary 2017-06-29 14:35:09 +00:00			`* [Keymap overview](keymap.md)`
			`* [Keycodes](keycodes.md)`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [Basic](keycodes_basic.md)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [Quantum](quantum_keycodes.md)`
			`* [Backlight](feature_backlight.md#backlight-keycodes)`
			`* [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)`
			`* [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)`
			`* [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)`
			`* [Mod+Key](feature_common_shortcuts.md#modifier-keys)`
			`* [Mod Tap](feature_common_shortcuts.md#mod-tap)`
			`* [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)`
			`* [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)`
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			`* [Stenography](stenography.md#keycode-reference)`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`* [RGB Light](feature_rgblight.md#rgblight-keycodes)`
			`* [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)`
			`* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)`
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			* [The `config.h` File](config_options.md)
Polish up custom_quantum_functions 2017-06-29 17:46:23 +00:00			`* [Customizing Functionality](custom_quantum_functions.md)`
Update a bunch of docs 2017-07-03 08:30:36 +00:00			`* [Documentation Best Practices](documentation_best_practices.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`
restructure summary 2017-06-29 14:35:09 +00:00			`* [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)`
			`* [Adding features to QMK](adding_features_to_qmk.md)`
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* [Hand Wiring Guide](hand_wiring.md)`
restructure summary 2017-06-29 14:35:09 +00:00			`* [ISP flashing guide](isp_flashing_guide.md)`
Add missing files to _summary.md 2017-07-03 19:39:15 +00:00			`* [Modding your keyboard](modding_your_keyboard.md)`
			`* [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.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)`