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

20
docs/reference_glossary.md
View file

@ -36,12 +36,12 @@ An alternative keyboard layout developed by Dr. August Dvorak in the 1930's. A s
## Dynamic Macro
A macro which has been recorded on the keyboard and which will be lost when the keyboard is unplugged or the computer rebooted.
* [Dynamic Macro Documentation](feature_dynamic_macros.md)
* [Dynamic Macro Documentation](feature_dynamic_macros)
## Eclipse
An IDE that is popular with many C developers.
* [Eclipse Setup Instructions](other_eclipse.md)
* [Eclipse Setup Instructions](other_eclipse)
## Firmware
The software that controls your MCU.
@ -59,7 +59,7 @@ In-system programming, a method of programming an AVR chip using external hardwa
An interface for receiving debugging messages from your keyboard. You can view these messages using [QMK Flasher](https://github.com/qmk/qmk_flasher) or [PJRC's hid_listen](https://www.pjrc.com/teensy/hid_listen.html)
## Keycode
A 2-byte number that represents a particular key. `0x00`-`0xFF` are used for [Basic Keycodes](keycodes_basic.md) while `0x100`-`0xFFFF` are used for [Quantum Keycodes](quantum_keycodes.md).
A 2-byte number that represents a particular key. `0x00`-`0xFF` are used for [Basic Keycodes](keycodes_basic) while `0x100`-`0xFFFF` are used for [Quantum Keycodes](quantum_keycodes).
## Key Down
An event that happens when a key is pressed down, but is completed before a key is released.
@ -76,7 +76,7 @@ An abstraction used to allow a key to serve multiple purposes. The highest activ
## Leader Key
A feature that allows you to tap the leader key followed by a sequence of 1, 2, or 3 keys to activate key presses or other quantum features.
* [Leader Key Documentation](feature_leader_key.md)
* [Leader Key Documentation](feature_leader_key)
## LED
Light Emitting Diode, the most common device used for indicators on a keyboard.
@ -90,7 +90,7 @@ A wiring pattern of columns and rows that enables the MCU to detect keypresses w
## Macro
A feature that lets you send multiple keypress events (hid reports) after having pressed only a single key.
* [Macro Documentation](feature_macros.md)
* [Macro Documentation](feature_macros)
## MCU
Microcontrol Unit, the processor that powers your keyboard.
@ -101,7 +101,7 @@ A key that is held down while typing another key to modify the action of that ke
## Mousekeys
A feature that lets you control your mouse cursor and click from your keyboard.
* [Mousekeys Documentation](feature_mouse_keys.md)
* [Mousekeys Documentation](feature_mouse_keys)
## N-Key Rollover (NKRO)
A term that applies to keyboards that are capable of reporting any number of key-presses at once.
@ -130,7 +130,7 @@ A 1 byte number that is sent as part of a HID report over USB that represents a
## Space Cadet Shift
A special set of shift keys which allow you to type various types of braces by tapping the left or right shift one or more times.
* [Space Cadet Shift Documentation](feature_space_cadet.md)
* [Space Cadet Shift Documentation](feature_space_cadet)
## Tap
Pressing and releasing a key. In some situations you will need to distinguish between a key down and a key up event, and Tap always refers to both at once.
@ -138,7 +138,7 @@ Pressing and releasing a key. In some situations you will need to distinguish be
## Tap Dance
A feature that lets you assign multiple keycodes to the same key based on how many times you press it.
* [Tap Dance Documentation](feature_tap_dance.md)
* [Tap Dance Documentation](feature_tap_dance)
## Teensy
A low-cost AVR development board that is commonly used for hand-wired builds. A teensy is often chosen despite costing a few dollars more due to its halfkay bootloader, which makes flashing very simple.
@ -149,12 +149,12 @@ A generic term for LEDs that light the underside of the board. These LEDs typica
## Unicode
In the larger computer world Unicode is a set of encoding schemes for representing characters in any language. As it relates to QMK it means using various OS schemes to send unicode codepoints instead of scancodes.
* [Unicode Documentation](feature_unicode.md)
* [Unicode Documentation](feature_unicode)
## Unit Testing
A framework for running automated tests against QMK. Unit testing helps us be confident that our changes do not break anything.
* [Unit Testing Documentation](unit_testing.md)
* [Unit Testing Documentation](unit_testing)
## USB
Universal Serial Bus, the most common wired interface for a keyboard.