drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Vitepress conversion of docs. (#23795)

Browse source
This commit is contained in:
Nick Brassel 2024-05-30 12:00:41 +10:00 • committed by GitHub
parent 395766657f
commit 6ef9717288
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
357 changed files with 3611 additions and 24208 deletions
Download patch file Download diff file Expand all files Collapse all files

82
docs/syllabus.md
View file

@ -4,19 +4,19 @@ This page helps you build up your QMK knowledge by introducing the basics first
# Beginning Topics
If you read nothing else you should read the documents in this section. After reading the [Tutorial](newbs.md) you should be able to create a basic keymap, compile it, and flash it to your keyboard. The remaining documents will flesh out your knowledge of these basics.
If you read nothing else you should read the documents in this section. After reading the [Tutorial](newbs) you should be able to create a basic keymap, compile it, and flash it to your keyboard. The remaining documents will flesh out your knowledge of these basics.
* **Learn How To Use QMK Tools**
* [Tutorial](newbs.md)
* [CLI](cli.md)
* [GIT](newbs_git_best_practices.md)
* [Tutorial](newbs)
* [CLI](cli)
* [GIT](newbs_git_best_practices)
* **Learn About Keymaps**
* [Layers](feature_layers.md)
* [Keycodes](keycodes.md)
* [Layers](feature_layers)
* [Keycodes](keycodes)
* The full list of keycodes you can use. Note that some may require knowledge found in the Intermediate or Advanced Topics.
* **Configuring IDEs** - Optional
* [Eclipse](other_eclipse.md)
* [VS Code](other_vscode.md)
* [Eclipse](other_eclipse)
* [VS Code](other_vscode)
# Intermediate Topics
@ -24,49 +24,49 @@ These topics start to dig into some of the features that QMK supports. You don't
* **Learn How To Configure Features**
<!-- * Configuration Overview FIXME(skullydazed/anyone): write this document -->
* [Audio](feature_audio.md)
* [Audio](feature_audio)
* Lighting
* [Backlight](feature_backlight.md)
* [LED Matrix](feature_led_matrix.md)
* [RGB Lighting](feature_rgblight.md)
* [RGB Matrix](feature_rgb_matrix.md)
* [Tap-Hold Configuration](tap_hold.md)
* [Squeezing Space from AVR](squeezing_avr.md)
* [Backlight](feature_backlight)
* [LED Matrix](feature_led_matrix)
* [RGB Lighting](feature_rgblight)
* [RGB Matrix](feature_rgb_matrix)
* [Tap-Hold Configuration](tap_hold)
* [Squeezing Space from AVR](squeezing_avr)
* **Learn More About Keymaps**
* [Keymaps](keymap.md)
* [Custom Functions and Keycodes](custom_quantum_functions.md)
* [Keymaps](keymap)
* [Custom Functions and Keycodes](custom_quantum_functions)
* Macros
* [Dynamic Macros](feature_dynamic_macros.md)
* [Compiled Macros](feature_macros.md)
* [Tap Dance](feature_tap_dance.md)
* [Combos](feature_combo.md)
* [Userspace](feature_userspace.md)
* [Key Overrides](feature_key_overrides.md)
* [Dynamic Macros](feature_dynamic_macros)
* [Compiled Macros](feature_macros)
* [Tap Dance](feature_tap_dance)
* [Combos](feature_combo)
* [Userspace](feature_userspace)
* [Key Overrides](feature_key_overrides)
# Advanced Topics
Everything below here requires a lot of foundational knowledge. Besides being able to create keymaps using advanced features you should be familiar with using both `config.h` and `rules.mk` to configure options for your keyboard.
* **Maintaining Keyboards Within QMK**
* [Handwiring a Keyboard](hand_wire.md)
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
* [info.json Reference](reference_info_json.md)
* [Debounce API](feature_debounce_type.md)
* [Handwiring a Keyboard](hand_wire)
* [Keyboard Guidelines](hardware_keyboard_guidelines)
* [info.json Reference](reference_info_json)
* [Debounce API](feature_debounce_type)
* **Advanced Features**
* [Unicode](feature_unicode.md)
* [API](api_overview.md)
* [Bootmagic Lite](feature_bootmagic.md)
* [Unicode](feature_unicode)
* [API](api_overview)
* [Bootmagic Lite](feature_bootmagic)
* **Hardware**
* [How Keyboards Work](how_keyboards_work.md)
* [How A Keyboard Matrix Works](how_a_matrix_works.md)
* [Split Keyboards](feature_split_keyboard.md)
* [Stenography](feature_stenography.md)
* [Pointing Devices](feature_pointing_device.md)
* [How Keyboards Work](how_keyboards_work)
* [How A Keyboard Matrix Works](how_a_matrix_works)
* [Split Keyboards](feature_split_keyboard)
* [Stenography](feature_stenography)
* [Pointing Devices](feature_pointing_device)
* **Core Development**
* [Coding Conventions](coding_conventions_c.md)
* [Compatible Microcontrollers](compatible_microcontrollers.md)
* [Custom Matrix](custom_matrix.md)
* [Understanding QMK](understanding_qmk.md)
* [Coding Conventions](coding_conventions_c)
* [Compatible Microcontrollers](compatible_microcontrollers)
* [Custom Matrix](custom_matrix)
* [Understanding QMK](understanding_qmk)
* **CLI Development**
* [Coding Conventions](coding_conventions_python.md)
* [CLI Development Overview](cli_development.md)
* [Coding Conventions](coding_conventions_python)
* [CLI Development Overview](cli_development)