qmk_firmware/docs/_sidebar.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)
  * [Best Practices](newbs_best_practices.md)
  * [Learning Resources](newbs_learn_more_resources.md)

* [QMK Basics](README.md)
  * [QMK Introduction](getting_started_introduction.md)
  * [Contributing to QMK](contributing.md)
  * [How to Use Github](getting_started_github.md)
  * [Getting Help](getting_started_getting_help.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)

* Detailed Guides
  * [Install Build Tools](getting_started_build_tools.md)
  * [Vagrant Guide](getting_started_vagrant.md)
  * [Build/Compile Instructions](getting_started_make_guide.md)
  * [Flashing Firmware](flashing.md)
  * [Customizing Functionality](custom_quantum_functions.md)
  * [Keymap Overview](keymap.md)

* [Hardware](hardware.md)
  * [AVR Processors](hardware_avr.md)
  * [Drivers](hardware_drivers.md)

* Reference
  * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
  * [Config Options](config_options.md)
  * [Keycodes](keycodes.md)
  * [Documentation Best Practices](documentation_best_practices.md)
  * [Documentation Templates](documentation_templates.md)
  * [Glossary](reference_glossary.md)
  * [Unit Testing](unit_testing.md)
  * [Useful Functions](ref_functions.md)
  * [Configurator Support](reference_configurator_support.md)

* [Features](features.md)
  * [Basic Keycodes](keycodes_basic.md)
  * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
  * [Quantum Keycodes](quantum_keycodes.md)
  * [Advanced Keycodes](feature_advanced_keycodes.md)
  * [Audio](feature_audio.md)
  * [Auto Shift](feature_auto_shift.md)
  * [Backlight](feature_backlight.md)
  * [Bluetooth](feature_bluetooth.md)
  * [Bootmagic](feature_bootmagic.md)
  * [Combos](feature_combo)
  * [Command](feature_command.md)
  * [Dynamic Macros](feature_dynamic_macros.md)
  * [Encoders](feature_encoders.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)
  * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
  * [Pointing Device](feature_pointing_device.md)
  * [PS/2 Mouse](feature_ps2_mouse.md)
  * [RGB Lighting](feature_rgblight.md)
  * [RGB Matrix](feature_rgb_matrix.md)
  * [Space Cadet Shift](feature_space_cadet_shift.md)
  * [Space Cadet Shift Enter](feature_space_cadet_shift_enter.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)

* For Makers and Modders
  * [Hand Wiring Guide](hand_wire.md)
  * [ISP Flashing Guide](isp_flashing_guide.md)
  * [ARM Debugging Guide](arm_debugging.md)
  * [I2C Driver](i2c_driver.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)
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [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)`
Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) * Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc 2018-10-18 22:12:11 +00:00			`* [Best Practices](newbs_best_practices.md)`
Cleanup learning newb links 2018-10-10 23:10:30 +00:00			`* [Learning Resources](newbs_learn_more_resources.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* [QMK Basics](README.md)`
			`* [QMK Introduction](getting_started_introduction.md)`
			`* [Contributing to QMK](contributing.md)`
			`* [How to Use Github](getting_started_github.md)`
			`* [Getting Help](getting_started_getting_help.md)`

Use docsfy to replace gitbook 2018-05-08 04:58:50 +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)`

First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* Detailed Guides`
			`* [Install Build Tools](getting_started_build_tools.md)`
			`* [Vagrant Guide](getting_started_vagrant.md)`
			`* [Build/Compile Instructions](getting_started_make_guide.md)`
			`* [Flashing Firmware](flashing.md)`
			`* [Customizing Functionality](custom_quantum_functions.md)`
			`* [Keymap Overview](keymap.md)`

Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Hardware](hardware.md)`
			`* [AVR Processors](hardware_avr.md)`
			`* [Drivers](hardware_drivers.md)`

First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* Reference`
			`* [Keyboard Guidelines](hardware_keyboard_guidelines.md)`
			`* [Config Options](config_options.md)`
			`* [Keycodes](keycodes.md)`
			`* [Documentation Best Practices](documentation_best_practices.md)`
			`* [Documentation Templates](documentation_templates.md)`
			`* [Glossary](reference_glossary.md)`
			`* [Unit Testing](unit_testing.md)`
Helpful functions 2018-08-26 03:01:09 +00:00			`* [Useful Functions](ref_functions.md)`
Docs: Supporting a keyboard in the QMK Configurator (#4396) * Docs: Configurator Support * Minor updates * Updated keyboard.h example to use #pragma once per @drashna https://github.com/qmk/qmk_firmware/pull/4396#discussion_r232140934 * Add link to doc under Reference section Added to _sidebar.md and _summary.md * Changed doc title; minor tweaks Re-titled the doc as "Supporting Your Keyboard in QMK Configurator". Made some minor changes to the keyboard.h examples. * Added tags object to JSON example 2018-11-15 02:32:28 +00:00			`* [Configurator Support](reference_configurator_support.md)`
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Features](features.md)`
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* [Basic Keycodes](keycodes_basic.md)`
Re-order feature list in sidebar (#4555) Specifically, moved the shifted keycodes to the top of the 'Feature' list, so it's more visible. This way, all of the keycodes are at the top of the list, rather than having the shifted keys at the bottom, so they should be easier to find since they're all in one place. 2018-12-05 18:28:06 +00:00			`* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)`
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* [Quantum Keycodes](quantum_keycodes.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Advanced Keycodes](feature_advanced_keycodes.md)`
			`* [Audio](feature_audio.md)`
			`* [Auto Shift](feature_auto_shift.md)`
			`* [Backlight](feature_backlight.md)`
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* [Bluetooth](feature_bluetooth.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Bootmagic](feature_bootmagic.md)`
Add documentation for Combo feature 2018-10-10 19:38:10 +00:00			`* [Combos](feature_combo)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Command](feature_command.md)`
			`* [Dynamic Macros](feature_dynamic_macros.md)`
add support for encoders to core 2018-10-26 20:19:23 +00:00			`* [Encoders](feature_encoders.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [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)`
First pass at reorganizing docs 2018-08-11 21:54:27 +00:00			`* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [Pointing Device](feature_pointing_device.md)`
			`* [PS/2 Mouse](feature_ps2_mouse.md)`
			`* [RGB Lighting](feature_rgblight.md)`
Make sure new features (RGB Matrix) are actually listed 2018-05-16 02:24:47 +00:00			`* [RGB Matrix](feature_rgb_matrix.md)`
Docs: Format Space Cadet documentation (#3540) * Format Space Cadet documentation * Fix page filenames * Move Caveats section up 2018-08-01 15:43:54 +00:00			`* [Space Cadet Shift](feature_space_cadet_shift.md)`
			`* [Space Cadet Shift Enter](feature_space_cadet_shift_enter.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00			`* [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)`

			`* For Makers and Modders`
			`* [Hand Wiring Guide](hand_wire.md)`
			`* [ISP Flashing Guide](isp_flashing_guide.md)`
ARM SWD guide - Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links. 2018-10-04 21:37:26 +00:00			`* [ARM Debugging Guide](arm_debugging.md)`
I2C driver docs (#4298) * I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix 2018-11-10 20:26:39 +00:00			`* [I2C Driver](i2c_driver.md)`
Use docsfy to replace gitbook 2018-05-08 04:58:50 +00:00
			`* 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)`