aboutsummaryrefslogtreecommitdiff
path: root/docs/_summary.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_summary.md')
-rw-r--r--docs/_summary.md68
1 files changed, 28 insertions, 40 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 69170d8bb..d439298da 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -1,36 +1,50 @@
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.md)
5 * [Build/Compile Instructions](getting_started_make_guide.md)
6 * [Flashing Firmware](flashing.md)
7 * [Contributing to QMK](contributing.md)
8 * [How to Use Github](getting_started_github.md)
9 * [Getting Help](getting_started_getting_help.md)
10
11* [Complete Newbs Guide](newbs.md) 1* [Complete Newbs Guide](newbs.md)
12 * [Getting Started](newbs_getting_started.md) 2 * [Getting Started](newbs_getting_started.md)
13 * [Building Your First Firmware](newbs_building_firmware.md) 3 * [Building Your First Firmware](newbs_building_firmware.md)
14 * [Flashing Firmware](newbs_flashing.md) 4 * [Flashing Firmware](newbs_flashing.md)
15 * [Testing and Debugging](newbs_testing_debugging.md) 5 * [Testing and Debugging](newbs_testing_debugging.md)
16 6
7* [QMK Basics](README.md)
8 * [QMK Introduction](getting_started_introduction.md)
9 * [Contributing to QMK](contributing.md)
10 * [How to Use Github](getting_started_github.md)
11 * [Getting Help](getting_started_getting_help.md)
12
17* [FAQ](faq.md) 13* [FAQ](faq.md)
18 * [General FAQ](faq_general.md) 14 * [General FAQ](faq_general.md)
19 * [Build/Compile QMK](faq_build.md) 15 * [Build/Compile QMK](faq_build.md)
20 * [Debugging/Troubleshooting QMK](faq_debug.md) 16 * [Debugging/Troubleshooting QMK](faq_debug.md)
21 * [Keymap](faq_keymap.md) 17 * [Keymap](faq_keymap.md)
22 18
19* Detailed Guides
20 * [Install Build Tools](getting_started_build_tools.md)
21 * [Vagrant Guide](getting_started_vagrant.md)
22 * [Build/Compile Instructions](getting_started_make_guide.md)
23 * [Flashing Firmware](flashing.md)
24 * [Customizing Functionality](custom_quantum_functions.md)
25 * [Keymap Overview](keymap.md)
26
23* [Hardware](hardware.md) 27* [Hardware](hardware.md)
24 * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
25 * [AVR Processors](hardware_avr.md) 28 * [AVR Processors](hardware_avr.md)
26 * ARM Processors (TBD)
27 * [Drivers](hardware_drivers.md) 29 * [Drivers](hardware_drivers.md)
28 30
31* Reference
32 * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
33 * [Config Options](config_options.md)
34 * [Keycodes](keycodes.md)
35 * [Documentation Best Practices](documentation_best_practices.md)
36 * [Documentation Templates](documentation_templates.md)
37 * [Glossary](reference_glossary.md)
38 * [Unit Testing](unit_testing.md)
39
29* [Features](features.md) 40* [Features](features.md)
41 * [Basic Keycodes](keycodes_basic.md)
42 * [Quantum Keycodes](quantum_keycodes.md)
30 * [Advanced Keycodes](feature_advanced_keycodes.md) 43 * [Advanced Keycodes](feature_advanced_keycodes.md)
31 * [Audio](feature_audio.md) 44 * [Audio](feature_audio.md)
32 * [Auto Shift](feature_auto_shift.md) 45 * [Auto Shift](feature_auto_shift.md)
33 * [Backlight](feature_backlight.md) 46 * [Backlight](feature_backlight.md)
47 * [Bluetooth](feature_bluetooth.md)
34 * [Bootmagic](feature_bootmagic.md) 48 * [Bootmagic](feature_bootmagic.md)
35 * [Command](feature_command.md) 49 * [Command](feature_command.md)
36 * [Dynamic Macros](feature_dynamic_macros.md) 50 * [Dynamic Macros](feature_dynamic_macros.md)
@@ -40,6 +54,7 @@
40 * [Leader Key](feature_leader_key.md) 54 * [Leader Key](feature_leader_key.md)
41 * [Macros](feature_macros.md) 55 * [Macros](feature_macros.md)
42 * [Mouse Keys](feature_mouse_keys.md) 56 * [Mouse Keys](feature_mouse_keys.md)
57 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
43 * [Pointing Device](feature_pointing_device.md) 58 * [Pointing Device](feature_pointing_device.md)
44 * [PS/2 Mouse](feature_ps2_mouse.md) 59 * [PS/2 Mouse](feature_ps2_mouse.md)
45 * [RGB Lighting](feature_rgblight.md) 60 * [RGB Lighting](feature_rgblight.md)
@@ -53,34 +68,7 @@
53 * [Thermal Printer](feature_thermal_printer.md) 68 * [Thermal Printer](feature_thermal_printer.md)
54 * [Unicode](feature_unicode.md) 69 * [Unicode](feature_unicode.md)
55 * [Userspace](feature_userspace.md) 70 * [Userspace](feature_userspace.md)
56 71 * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
57* [Keycodes](keycodes.md)
58 * [Basic](keycodes_basic.md)
59 * [Quantum](quantum_keycodes.md)
60 * [Audio](feature_audio.md#audio-keycodes)
61 * [Backlight](feature_backlight.md#backlight-keycodes)
62 * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
63 * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
64 * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
65 * [Mod+Key](feature_advanced_keycodes.md#modifier-keys)
66 * [Mod Tap](feature_advanced_keycodes.md#mod-tap)
67 * [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys)
68 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
69 * [RGB Light](feature_rgblight.md#rgblight-keycodes)
70 * [RGB Matrix](feature_rgb_matrix.md#keycodes)
71 * [Shifted Keys](keycodes_us_ansi_shifted.md)
72 * [Stenography](feature_stenography.md#keycode-reference)
73 * [Swap Hands](feature_swap_hands.md#swap-keycodes)
74 * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
75
76* Reference
77 * [Config Options](config_options.md)
78 * [Customizing Functionality](custom_quantum_functions.md)
79 * [Documentation Best Practices](documentation_best_practices.md)
80 * [Documentation Templates](documentation_templates.md)
81 * [Glossary](reference_glossary.md)
82 * [Keymap Overview](keymap.md)
83 * [Unit Testing](unit_testing.md)
84 72
85* For Makers and Modders 73* For Makers and Modders
86 * [Hand Wiring Guide](hand_wire.md) 74 * [Hand Wiring Guide](hand_wire.md)