X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2F_summary.md;h=55cfd2ab3d8b31fefc60a5760c46888f85da58ca;hb=06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b;hp=f2229be694affa51f20e2b489e03c7dafe070d14;hpb=391eae97e49de471a8320f05ed5c8976874aedb0;p=qmk_firmware.git diff --git a/docs/_summary.md b/docs/_summary.md index f2229be69..55cfd2ab3 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,36 +1,72 @@ -* Getting started - * [Introduction](home.md) - * [QMK Overview](qmk_overview.md) - * [Build Environment Setup](build_environment_setup.md) - * [Make instructions](make_instructions.md) - * [FAQ: Creating a Keymap](faq_keymap.md) - * [FAQ: Compiling QMK](faq_build.md) +* [Getting started](README.md) + * [QMK Introduction](getting_started_introduction.md) + * [Install Build Tools](getting_started_build_tools.md) + * Alternative: [Vagrant Guide](getting_started_vagrant_guide.md) + * [Build/Compile instructions](getting_started_make_guide.md) + * [Contributing to QMK](contributing.md) + * [How to Use Github](getting_started_github.md) -* [Features](features/README.md) - * [Layer switching](key_functions.md) - * [Leader Key](leader_key.md) - * [Macros](macros.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) + +* [Features](features.md) + * [Layouts](feature_layouts.md) + * [Common Shortcuts](feature_common_shortcuts.md) + * [Userspace](feature_userspace.md) + * [Backlight](feature_backlight.md) + * [Bootmagic](feature_bootmagic.md) * [Dynamic Macros](dynamic_macros.md) + * [Key Lock](key_lock.md) + * [Leader Key](feature_leader_key.md) + * [Macros](macros.md) + * [Mouse keys](mouse_keys.md) + * [Pointing Device](feature_pointing_device.md) + * [PS2 Mouse](feature_ps2_mouse.md) * [Space Cadet](space_cadet_shift.md) * [Tap Dance](tap_dance.md) - * [Mouse keys](mouse_keys.md) + * [Audio](feature_audio.md) + * [Thermal Printer](feature_thermal_printer.md) + * [Stenography](stenography.md) + * [Unicode](unicode.md) + * [Terminal](feature_terminal.md) * Reference + * [Glossary](glossary.md) * [Keymap overview](keymap.md) * [Keycodes](keycodes.md) - * [Basic Keycodes](basic_keycodes.md) - * [Quantum Keycodes](quantum_keycodes.md) - * [The Config File](config_options.md) - * [Custom Quantum Functions](custom_quantum_functions.md) - -* For makers and modders + * [Basic](keycodes_basic.md) + * [Quantum](quantum_keycodes.md) + * [Backlight](feature_backlight.md#backlight-keycodes) + * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) + * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) + * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers) + * [Mod+Key](feature_common_shortcuts.md#modifier-keys) + * [Mod Tap](feature_common_shortcuts.md#mod-tap) + * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys) + * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes) + * [Stenography](stenography.md#keycode-reference) + * [RGB Light](feature_rgblight.md#rgblight-keycodes) + * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) + * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) + * [The `config.h` File](config_options.md) + * [Customizing Functionality](custom_quantum_functions.md) + * [Documentation Best Practices](documentation_best_practices.md) + * [Documentation Templates](documentation_templates.md) + * [Unit Testing](unit_testing.md) + +* For Makers and Modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) - * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) - * [Modding your keyboard](modding_your_keyboard.md) - * [Adding features to QMK](adding_features_to_qmk.md) + * [Hand Wiring Guide](hand_wiring.md) * [ISP flashing guide](isp_flashing_guide.md) - -* Other topics - * [General FAQ](faq.md) - * [Differences from TMK](differences_from_tmk.md) + * [Modding your keyboard](modding_your_keyboard.md) + * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.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)