diff options
Diffstat (limited to 'docs/_sidebar.md')
| -rw-r--r-- | docs/_sidebar.md | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 000000000..318c526a8 --- /dev/null +++ b/docs/_sidebar.md | |||
| @@ -0,0 +1,98 @@ | |||
| 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) | ||
| 12 | * [Getting Started](newbs_getting_started.md) | ||
| 13 | * [Building Your First Firmware](newbs_building_firmware.md) | ||
| 14 | * [Flashing Firmware](newbs_flashing.md) | ||
| 15 | * [Testing and Debugging](newbs_testing_debugging.md) | ||
| 16 | |||
| 17 | * [FAQ](faq.md) | ||
| 18 | * [General FAQ](faq_general.md) | ||
| 19 | * [Build/Compile QMK](faq_build.md) | ||
| 20 | * [Debugging/Troubleshooting QMK](faq_debug.md) | ||
| 21 | * [Keymap](faq_keymap.md) | ||
| 22 | |||
| 23 | * [Hardware](hardware.md) | ||
| 24 | * [Keyboard Guidelines](hardware_keyboard_guidelines.md) | ||
| 25 | * [AVR Processors](hardware_avr.md) | ||
| 26 | * ARM Processors (TBD) | ||
| 27 | * [Drivers](hardware_drivers.md) | ||
| 28 | |||
| 29 | * [Features](features.md) | ||
| 30 | * [Advanced Keycodes](feature_advanced_keycodes.md) | ||
| 31 | * [Audio](feature_audio.md) | ||
| 32 | * [Auto Shift](feature_auto_shift.md) | ||
| 33 | * [Backlight](feature_backlight.md) | ||
| 34 | * [Bootmagic](feature_bootmagic.md) | ||
| 35 | * [Command](feature_command.md) | ||
| 36 | * [Dynamic Macros](feature_dynamic_macros.md) | ||
| 37 | * [Grave Escape](feature_grave_esc.md) | ||
| 38 | * [Key Lock](feature_key_lock.md) | ||
| 39 | * [Layouts](feature_layouts.md) | ||
| 40 | * [Leader Key](feature_leader_key.md) | ||
| 41 | * [Macros](feature_macros.md) | ||
| 42 | * [Mouse Keys](feature_mouse_keys.md) | ||
| 43 | * [Pointing Device](feature_pointing_device.md) | ||
| 44 | * [PS/2 Mouse](feature_ps2_mouse.md) | ||
| 45 | * [RGB Lighting](feature_rgblight.md) | ||
| 46 | * [Space Cadet](feature_space_cadet.md) | ||
| 47 | * [Stenography](feature_stenography.md) | ||
| 48 | * [Swap Hands](feature_swap_hands.md) | ||
| 49 | * [Tap Dance](feature_tap_dance.md) | ||
| 50 | * [Terminal](feature_terminal.md) | ||
| 51 | * [Thermal Printer](feature_thermal_printer.md) | ||
| 52 | * [Unicode](feature_unicode.md) | ||
| 53 | * [Userspace](feature_userspace.md) | ||
| 54 | |||
| 55 | * [Keycodes](keycodes.md) | ||
| 56 | * [Backlight](feature_backlight.md#backlight-keycodes) | ||
| 57 | * [Basic](keycodes_basic.md) | ||
| 58 | * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) | ||
| 59 | * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) | ||
| 60 | * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) | ||
| 61 | * [Mod+Key](feature_advanced_keycodes.md#modifier-keys) | ||
| 62 | * [Mod Tap](feature_advanced_keycodes.md#mod-tap) | ||
| 63 | * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) | ||
| 64 | * [Quantum](quantum_keycodes.md) | ||
| 65 | * [RGB Light](feature_rgblight.md#rgblight-keycodes) | ||
| 66 | * [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes) | ||
| 67 | * [Stenography](feature_stenography.md#keycode-reference) | ||
| 68 | * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) | ||
| 69 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) | ||
| 70 | |||
| 71 | * Reference | ||
| 72 | * [Config Options](config_options.md) | ||
| 73 | * [Customizing Functionality](custom_quantum_functions.md) | ||
| 74 | * [Documentation Best Practices](documentation_best_practices.md) | ||
| 75 | * [Documentation Templates](documentation_templates.md) | ||
| 76 | * [Glossary](reference_glossary.md) | ||
| 77 | * [Keymap Overview](keymap.md) | ||
| 78 | * [Unit Testing](unit_testing.md) | ||
| 79 | |||
| 80 | * For Makers and Modders | ||
| 81 | * [Hand Wiring Guide](hand_wire.md) | ||
| 82 | * [ISP Flashing Guide](isp_flashing_guide.md) | ||
| 83 | |||
| 84 | * For a Deeper Understanding | ||
| 85 | * [How Keyboards Work](how_keyboards_work.md) | ||
| 86 | * [Understanding QMK](understanding_qmk.md) | ||
| 87 | |||
| 88 | * Other Topics | ||
| 89 | * [Using Eclipse with QMK](eclipse.md) | ||
| 90 | |||
| 91 | * QMK Internals (In Progress) | ||
| 92 | * [Defines](internals_defines.md) | ||
| 93 | * [Input Callback Reg](internals_input_callback_reg.md) | ||
| 94 | * [Midi Device](internals_midi_device.md) | ||
| 95 | * [Midi Device Setup Process](internals_midi_device_setup_process.md) | ||
| 96 | * [Midi Util](internals_midi_util.md) | ||
| 97 | * [Send Functions](internals_send_functions.md) | ||
| 98 | * [Sysex Tools](internals_sysex_tools.md) | ||