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