summaryrefslogtreecommitdiffstats
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2017-12-09 06:45:13 +0100
committerJack Humbert <jack.humb@gmail.com>2017-12-09 16:46:11 +0100
commit4c675a83ba1d3561bfd6baad57a250066f5db4d3 (patch)
treec17e42238c29d0ebf9a3f55b2b13a0ac5f3dbae0 /docs/feature_rgblight.md
parent7b0356d1d49da6574570e110f61f95692afdb3d0 (diff)
downloadqmk_firmware-4c675a83ba1d3561bfd6baad57a250066f5db4d3.tar.gz
qmk_firmware-4c675a83ba1d3561bfd6baad57a250066f5db4d3.tar.xz
Format keycode tables
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 8f4f08024..554eb2dcd 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -98,25 +98,25 @@ rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM
These control the RGB Lighting functionality.
-| Long Name | Short Name | Description |
-|-----------|------------|-------------|
-||`RGB_TOG`|toggle on/off|
-|`RGB_MODE_FORWARD`|`RGB_MOD`|cycle through modes, use reverse direction when shift is held|
-|`RGB_MODE_REVERSE`|`RGB_RMOD`|cycle through modes in reverse (also suppost shift to go forward)|
-||`RGB_HUI`|hue increase|
-||`RGB_HUD`|hue decrease|
-||`RGB_SAI`|saturation increase|
-||`RGB_SAD`|saturation decrease|
-||`RGB_VAI`|value (brightness) increase|
-||`RGB_VAD`|value (brightness) decrease|
-|`RGB_MODE_PLAIN`|`RGB_M_P `| Switch to the static no animation mode |
-|`RGB_MODE_BREATHE`|`RGB_M_B`| Switch to the breathing mode |
-|`RGB_MODE_RAINBOW`|`RGB_M_R`| Switch to the rainbow mode ||
-|`RGB_MODE_SWIRL`|`RGB_M_SW`| Switch to the swirl mode |
-|`RGB_MODE_SNAKE`|`RGB_M_SN`| Switch to the snake mode |
-|`RGB_MODE_KNIGHT`|`RGB_M_K`| Switch to the knight animation |
-|`RGB_MODE_XMAS`|`RGB_M_X`| Switch to the Christmas animation |
-|`RGB_MODE_GRADIENT`|`RGB_M_G`| Switch to the static gradient mode |
+|Key |Aliases |Description |
+|-------------------|----------|--------------------------------------------------------------------|
+|`RGB_TOG` | |Toggle RGB lighting on or off |
+|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
+|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
+|`RGB_HUI` | |Increase hue |
+|`RGB_HUD` | |Decrease hue |
+|`RGB_SAI` | |Increase saturation |
+|`RGB_SAD` | |Decrease saturation |
+|`RGB_VAI` | |Increase value (brightness) |
+|`RGB_VAD` | |Decrease value (brightness) |
+|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode |
+|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode |
+|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode |
+|`RGB_MODE_SWIRL` |`RGB_M_SW`|Swirl animation mode |
+|`RGB_MODE_SNAKE` |`RGB_M_SN`|Snake animation mode |
+|`RGB_MODE_KNIGHT` |`RGB_M_K` |"Knight Rider" animation mode |
+|`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode |
+|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`.