From 6facb7a079740f975c41c9ae8d95f0735097933e Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Wed, 8 Jan 2025 03:12:54 +0000 Subject: [PATCH 1/2] Convert stray legacy warn/info docs panels (#24799) --- docs/feature_macros.md | 4 +++- docs/feature_userspace.md | 5 +++-- docs/features/mouse_keys.md | 4 +++- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/feature_macros.md b/docs/feature_macros.md index b4e37a1ba96f..404eb4b38d94 100644 --- a/docs/feature_macros.md +++ b/docs/feature_macros.md @@ -117,7 +117,9 @@ If yes, we send the string `"QMK is the best thing ever!"` to the computer via t We return `true` to indicate to the caller that the key press we just processed should continue to be processed as normal (as we didn't replace or alter the functionality). Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button. -?>It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions). +::: tip +It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions). +::: You might want to add more than one macro. You can do that by adding another keycode and adding another case to the switch statement, like so: diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md index 1e7c3b37cdc6..d19b86cb46c8 100644 --- a/docs/feature_userspace.md +++ b/docs/feature_userspace.md @@ -74,8 +74,9 @@ Additionally, `config.h` here will be processed like the same file in your keyma The reason for this, is that `.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `` file in any `config.h` files will result in compile issues. -!>You should use the `config.h` for [configuration options](config_options), and the `.h` file for user or keymap specific settings (such as the enum for layer or keycodes) - +::: warning +You should use the `config.h` for [configuration options](config_options), and the `.h` file for user or keymap specific settings (such as the enum for layer or keycodes) +::: ## Readme (`readme.md`) diff --git a/docs/features/mouse_keys.md b/docs/features/mouse_keys.md index d755084f8e63..86b50fa9c8d1 100644 --- a/docs/features/mouse_keys.md +++ b/docs/features/mouse_keys.md @@ -214,7 +214,9 @@ When additional overlapping mouse key is pressed, the mouse cursor will continue |`MOUSEKEY_OVERLAP_WHEEL_DELTA`|`MOUSEKEY_WHEEL_DELTA`|Step size of reset mouse wheel acceleration | |`MOUSEKEY_OVERLAP_INTERVAL` |`MOUSEKEY_INTERVAL` |Reset time between cursor movements in milliseconds (Kinetic mode only)| -?> This feature will not be applied on Inertial mode +::: tip +This feature will not be applied on Inertial mode +::: ## Use with PS/2 Mouse and Pointing Device From 95c74b6276c95fab5e04e22b1f1cd30aedead6fa Mon Sep 17 00:00:00 2001 From: jack Date: Wed, 8 Jan 2025 04:13:04 +0100 Subject: [PATCH 2/2] [Docs] Fix wording in Mod Tap documentation (#24796) --- docs/mod_tap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mod_tap.md b/docs/mod_tap.md index 37c2ba3473bc..da2ecc9a854d 100644 --- a/docs/mod_tap.md +++ b/docs/mod_tap.md @@ -2,7 +2,7 @@ The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down. -The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`: +The modifiers (`mod`) argument to the `MT()` macro are prefixed with `MOD_`, not `KC_`: |Modifier |Description | |----------|----------------------------------------|