diff options
Diffstat (limited to 'docs/_summary.md')
| -rw-r--r-- | docs/_summary.md | 155 |
1 files changed, 83 insertions, 72 deletions
diff --git a/docs/_summary.md b/docs/_summary.md index dee8a3198..994d58557 100644 --- a/docs/_summary.md +++ b/docs/_summary.md | |||
| @@ -1,17 +1,20 @@ | |||
| 1 | * Complete Newbs Guide | 1 | * Complete Newbs Guide |
| 2 | * [Introduction](newbs.md) | 2 | * [Introduction](newbs.md) |
| 3 | * [Getting Started](newbs_getting_started.md) | 3 | * [Setup](newbs_getting_started.md) |
| 4 | * [Building Your First Firmware](newbs_building_firmware.md) | 4 | * [Building Your First Firmware](newbs_building_firmware.md) |
| 5 | * [Flashing Firmware](newbs_flashing.md) | 5 | * [Flashing Firmware](newbs_flashing.md) |
| 6 | * [Testing and Debugging](newbs_testing_debugging.md) | 6 | * [Testing and Debugging](newbs_testing_debugging.md) |
| 7 | * [Getting Help](getting_started_getting_help.md) | 7 | * [Getting Help](getting_started_getting_help.md) |
| 8 | * Other Topics | ||
| 9 | * [Learning Resources](newbs_learn_more_resources.md) | ||
| 10 | * [Using Eclipse with QMK](other_eclipse.md) | ||
| 11 | * [Using VSCode with QMK](other_vscode.md) | ||
| 8 | 12 | ||
| 9 | * FAQs | 13 | * FAQs |
| 10 | * [General FAQ](faq_general.md) | 14 | * [General FAQ](faq_general.md) |
| 11 | * [Build/Compile QMK](faq_build.md) | 15 | * [Build/Compile QMK](faq_build.md) |
| 12 | * [Debugging/Troubleshooting QMK](faq_debug.md) | 16 | * [Debugging/Troubleshooting QMK](faq_debug.md) |
| 13 | * [Keymap](faq_keymap.md) | 17 | * [Keymap](faq_keymap.md) |
| 14 | * [Driver Installation with Zadig](driver_installation_zadig.md) | ||
| 15 | 18 | ||
| 16 | * Configurator | 19 | * Configurator |
| 17 | * [Overview](newbs_building_firmware_configurator.md) | 20 | * [Overview](newbs_building_firmware_configurator.md) |
| @@ -20,74 +23,80 @@ | |||
| 20 | * [Overview](api_overview.md) | 23 | * [Overview](api_overview.md) |
| 21 | * [API Documentation](api_docs.md) | 24 | * [API Documentation](api_docs.md) |
| 22 | 25 | ||
| 26 | * CLI | ||
| 27 | * [Overview](cli.md) | ||
| 28 | * [Configuration](cli_configuration.md) | ||
| 29 | * [Commands](cli_commands.md) | ||
| 30 | |||
| 23 | * Using QMK | 31 | * Using QMK |
| 24 | * Guides | 32 | * Guides |
| 25 | * [ARM Debugging Guide](arm_debugging.md) | ||
| 26 | * [Best Git Practices](newbs_git_best_practices.md) | ||
| 27 | * [Contributing to QMK](contributing.md) | ||
| 28 | * [Customizing Functionality](custom_quantum_functions.md) | 33 | * [Customizing Functionality](custom_quantum_functions.md) |
| 29 | * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md) | 34 | * [Driver Installation with Zadig](driver_installation_zadig.md) |
| 30 | * [Flashing Firmware](flashing.md) | ||
| 31 | * [Github Best Practices](getting_started_github.md) | ||
| 32 | * [Hand Wiring Guide](hand_wire.md) | ||
| 33 | * [ISP Flashing Guide](isp_flashing_guide.md) | ||
| 34 | * [Keymap Overview](keymap.md) | 35 | * [Keymap Overview](keymap.md) |
| 35 | * [Learning Resources](newbs_learn_more_resources.md) | ||
| 36 | * [QMK CLI](cli.md) | ||
| 37 | * [Vagrant Guide](getting_started_vagrant.md) | 36 | * [Vagrant Guide](getting_started_vagrant.md) |
| 37 | * Flashing | ||
| 38 | * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md) | ||
| 39 | * [Flashing Firmware](flashing.md) | ||
| 40 | * Git Best Practices | ||
| 41 | * [Introduction](newbs_git_best_practices.md) | ||
| 42 | * [Your Fork](newbs_git_using_your_master_branch.md) | ||
| 43 | * [Merge Conflicts](newbs_git_resolving_merge_conflicts.md) | ||
| 44 | * [Fixing Your Branch](newbs_git_resynchronize_a_branch.md) | ||
| 45 | * Keyboard Building | ||
| 46 | * [Hand Wiring Guide](hand_wire.md) | ||
| 47 | * [ISP Flashing Guide](isp_flashing_guide.md) | ||
| 38 | 48 | ||
| 39 | * QMK Features | 49 | * Simple Keycodes |
| 40 | * Keycodes | 50 | * [Full List](keycodes.md) |
| 41 | * [Full List](keycodes.md) | 51 | * [Basic Keycodes](keycodes_basic.md) |
| 42 | * [Basic Keycodes](keycodes_basic.md) | 52 | * [Advanced Keycodes](feature_advanced_keycodes.md) |
| 43 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) | 53 | * [Quantum Keycodes](quantum_keycodes.md) |
| 44 | * [Quantum Keycodes](quantum_keycodes.md) | ||
| 45 | * [Advanced Keycodes](feature_advanced_keycodes.md) | ||
| 46 | 54 | ||
| 47 | * Software Features | 55 | * Advanced Keycodes |
| 48 | * [Auto Shift](feature_auto_shift.md) | 56 | * [Auto Shift](feature_auto_shift.md) |
| 49 | * [Combos](feature_combo.md) | 57 | * [Command](feature_command.md) |
| 50 | * [Command](feature_command.md) | 58 | * [Dynamic Macros](feature_dynamic_macros.md) |
| 51 | * [Debounce API](feature_debounce_type.md) | 59 | * [Grave Escape](feature_grave_esc.md) |
| 52 | * [Dynamic Macros](feature_dynamic_macros.md) | 60 | * [Leader Key](feature_leader_key.md) |
| 53 | * [Grave Escape](feature_grave_esc.md) | 61 | * [Macros](feature_macros.md) |
| 54 | * [Key Lock](feature_key_lock.md) | 62 | * [Mouse Keys](feature_mouse_keys.md) |
| 55 | * [Leader Key](feature_leader_key.md) | 63 | * [Space Cadet Shift](feature_space_cadet.md) |
| 56 | * [Macros](feature_macros.md) | 64 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) |
| 57 | * [Mouse Keys](feature_mouse_keys.md) | ||
| 58 | * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) | ||
| 59 | * [Pointing Device](feature_pointing_device.md) | ||
| 60 | * [Space Cadet](feature_space_cadet.md) | ||
| 61 | * [Swap Hands](feature_swap_hands.md) | ||
| 62 | * [Tap Dance](feature_tap_dance.md) | ||
| 63 | * [Terminal](feature_terminal.md) | ||
| 64 | * [Unicode](feature_unicode.md) | ||
| 65 | * [Userspace](feature_userspace.md) | ||
| 66 | 65 | ||
| 67 | * Hardware Features | 66 | * Software Features |
| 68 | * [Audio](feature_audio.md) | 67 | * [Combos](feature_combo.md) |
| 69 | * [Backlight](feature_backlight.md) | 68 | * [Debounce API](feature_debounce_type.md) |
| 70 | * [Bluetooth](feature_bluetooth.md) | 69 | * [Key Lock](feature_key_lock.md) |
| 71 | * [Bootmagic](feature_bootmagic.md) | 70 | * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) |
| 72 | * [Custom Matrix](custom_matrix.md) | 71 | * [Pointing Device](feature_pointing_device.md) |
| 73 | * [DIP Switch](feature_dip_switch.md) | 72 | * [Swap Hands](feature_swap_hands.md) |
| 74 | * [Encoders](feature_encoders.md) | 73 | * [Tap Dance](feature_tap_dance.md) |
| 75 | * [Haptic Feedback](feature_haptic_feedback.md) | 74 | * [Terminal](feature_terminal.md) |
| 75 | * [Unicode](feature_unicode.md) | ||
| 76 | * [Userspace](feature_userspace.md) | ||
| 77 | |||
| 78 | * Hardware Features | ||
| 79 | * Displays | ||
| 76 | * [HD44780 LCD Controller](feature_hd44780.md) | 80 | * [HD44780 LCD Controller](feature_hd44780.md) |
| 77 | * [LED Matrix](feature_led_matrix.md) | ||
| 78 | * [OLED Driver](feature_oled_driver.md) | 81 | * [OLED Driver](feature_oled_driver.md) |
| 79 | * [Proton C Conversion](proton_c_conversion.md) | 82 | * Lighting |
| 80 | * [PS/2 Mouse](feature_ps2_mouse.md) | 83 | * [Backlight](feature_backlight.md) |
| 84 | * [LED Matrix](feature_led_matrix.md) | ||
| 81 | * [RGB Lighting](feature_rgblight.md) | 85 | * [RGB Lighting](feature_rgblight.md) |
| 82 | * [RGB Matrix](feature_rgb_matrix.md) | 86 | * [RGB Matrix](feature_rgb_matrix.md) |
| 83 | * [Split Keyboard](feature_split_keyboard.md) | 87 | * [Audio](feature_audio.md) |
| 84 | * [Stenography](feature_stenography.md) | 88 | * [Bluetooth](feature_bluetooth.md) |
| 85 | * [Thermal Printer](feature_thermal_printer.md) | 89 | * [Bootmagic](feature_bootmagic.md) |
| 86 | * [Velocikey](feature_velocikey.md) | 90 | * [Custom Matrix](custom_matrix.md) |
| 87 | 91 | * [DIP Switch](feature_dip_switch.md) | |
| 88 | * Other Topics | 92 | * [Encoders](feature_encoders.md) |
| 89 | * [Using Eclipse with QMK](other_eclipse.md) | 93 | * [Haptic Feedback](feature_haptic_feedback.md) |
| 90 | * [Using VSCode with QMK](other_vscode.md) | 94 | * [Proton C Conversion](proton_c_conversion.md) |
| 95 | * [PS/2 Mouse](feature_ps2_mouse.md) | ||
| 96 | * [Split Keyboard](feature_split_keyboard.md) | ||
| 97 | * [Stenography](feature_stenography.md) | ||
| 98 | * [Thermal Printer](feature_thermal_printer.md) | ||
| 99 | * [Velocikey](feature_velocikey.md) | ||
| 91 | 100 | ||
| 92 | * Developing QMK | 101 | * Developing QMK |
| 93 | * Breaking Changes | 102 | * Breaking Changes |
| @@ -96,19 +105,8 @@ | |||
| 96 | * History | 105 | * History |
| 97 | * [2019 Aug 30](ChangeLog/20190830.md) | 106 | * [2019 Aug 30](ChangeLog/20190830.md) |
| 98 | 107 | ||
| 99 | * QMK Reference | ||
| 100 | * [Translating the QMK Docs](translating.md) | ||
| 101 | * [Config Options](config_options.md) | ||
| 102 | * [Make Documentation](getting_started_make_guide.md) | ||
| 103 | * [Documentation Best Practices](documentation_best_practices.md) | ||
| 104 | * [Documentation Templates](documentation_templates.md) | ||
| 105 | * [Glossary](reference_glossary.md) | ||
| 106 | * [Community Layouts](feature_layouts.md) | ||
| 107 | * [Unit Testing](unit_testing.md) | ||
| 108 | * [Useful Functions](ref_functions.md) | ||
| 109 | * [info.json Format](reference_info_json.md) | ||
| 110 | |||
| 111 | * C Development | 108 | * C Development |
| 109 | * [ARM Debugging Guide](arm_debugging.md) | ||
| 112 | * [AVR Processors](hardware_avr.md) | 110 | * [AVR Processors](hardware_avr.md) |
| 113 | * [Coding Conventions](coding_conventions_c.md) | 111 | * [Coding Conventions](coding_conventions_c.md) |
| 114 | * [Compatible Microcontrollers](compatible_microcontrollers.md) | 112 | * [Compatible Microcontrollers](compatible_microcontrollers.md) |
| @@ -122,14 +120,27 @@ | |||
| 122 | 120 | ||
| 123 | * Python Development | 121 | * Python Development |
| 124 | * [Coding Conventions](coding_conventions_python.md) | 122 | * [Coding Conventions](coding_conventions_python.md) |
| 125 | * [QMK CLI Config](cli_configuration.md) | 123 | * [QMK CLI Development](cli_development.md) |
| 126 | * [Python CLI Development](cli_development.md) | 124 | * [QMK CLI Config](cli_dev_configuration.md) |
| 127 | 125 | ||
| 128 | * Configurator Development | 126 | * Configurator Development |
| 129 | * QMK API | 127 | * QMK API |
| 130 | * [Development Environment](api_development_environment.md) | 128 | * [Development Environment](api_development_environment.md) |
| 131 | * [Architecture Overview](api_development_overview.md) | 129 | * [Architecture Overview](api_development_overview.md) |
| 132 | 130 | ||
| 131 | * QMK Reference | ||
| 132 | * [Contributing to QMK](contributing.md) | ||
| 133 | * [Translating the QMK Docs](translating.md) | ||
| 134 | * [Config Options](config_options.md) | ||
| 135 | * [Make Documentation](getting_started_make_guide.md) | ||
| 136 | * [Documentation Best Practices](documentation_best_practices.md) | ||
| 137 | * [Documentation Templates](documentation_templates.md) | ||
| 138 | * [Glossary](reference_glossary.md) | ||
| 139 | * [Community Layouts](feature_layouts.md) | ||
| 140 | * [Unit Testing](unit_testing.md) | ||
| 141 | * [Useful Functions](ref_functions.md) | ||
| 142 | * [info.json Format](reference_info_json.md) | ||
| 143 | |||
| 133 | * For a Deeper Understanding | 144 | * For a Deeper Understanding |
| 134 | * [How Keyboards Work](how_keyboards_work.md) | 145 | * [How Keyboards Work](how_keyboards_work.md) |
| 135 | * [Understanding QMK](understanding_qmk.md) | 146 | * [Understanding QMK](understanding_qmk.md) |