commit 0fb3aaec8e80a0277e50af74d9abb8680c979ed9
parent b7df75e47f446bd2e969f3adb8cb584852929213
Author: 猫咪恐慌 <30993222+kitty-panics@users.noreply.github.com>
Date: Tue, 28 Nov 2023 21:48:47 -0500
[Doc]: Correct Markdown syntax errors. (#22511)
Diffstat:
5 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/docs/feature_combo.md b/docs/feature_combo.md
@@ -345,10 +345,9 @@ is not set, all other layers will reference themselves.
}
return layer; // important if default is not in case.
}
-
```
-
- The equivalent definition using the combo macros is this:
+
+The equivalent definition using the combo macros is this:
```c
COMBO_REF_LAYER(_DVORAK, _QWERTY)
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
@@ -213,7 +213,7 @@ These configuration options should be placed in `config.h`. Example:
|`OLED_SCROLL_TIMEOUT_RIGHT`|*Not defined* |Scroll timeout direction is right when defined, left when undefined. |
|`OLED_TIMEOUT` |`60000` |Turns off the OLED screen after 60000ms of screen update inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. |
|`OLED_UPDATE_INTERVAL` |`0` (`50` for split keyboards) |Set the time interval for updating the OLED display in ms. This will improve the matrix scan rate. |
-|`OLED_UPDATE_PROCESS_LIMIT'|`1` |Set the number of dirty blocks to render per loop. Increasing may degrade performance. |
+|`OLED_UPDATE_PROCESS_LIMIT`|`1` |Set the number of dirty blocks to render per loop. Increasing may degrade performance. |
### I2C Configuration
|Define |Default |Description |
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
@@ -800,9 +800,11 @@ layer_state_t layer_state_set_user(layer_state_t state) {
#### Set different target layer when a particular layer is active:
-The below code will change the auto mouse layer target to `_MOUSE_LAYER_2` when `_DEFAULT_LAYER_2` is highest default layer state.
-*NOTE: that `auto_mouse_layer_off` is used here instead of `remove_auto_mouse_layer` as `default_layer_state_set_*` stack is separate from the `layer_state_set_*` stack* if something similar was to be done in `layer_state_set_user `state = remove_auto_mouse_layer(state, false)` should be used instead
-*ADDITIONAL NOTE: `AUTO_MOUSE_TARGET_LAYER` is checked if already set to avoid deactivating the target layer unless needed*
+The below code will change the auto mouse layer target to `_MOUSE_LAYER_2` when `_DEFAULT_LAYER_2` is highest default layer state.
+
+*NOTE: that `auto_mouse_layer_off` is used here instead of `remove_auto_mouse_layer` as `default_layer_state_set_*` stack is separate from the `layer_state_set_*` stack*, if something similar was to be done in `layer_state_set_user`, `state = remove_auto_mouse_layer(state, false)` should be used instead.
+
+*ADDITIONAL NOTE: `AUTO_MOUSE_TARGET_LAYER` is checked if already set to avoid deactivating the target layer unless needed*.
```c
// in keymap.c
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
@@ -205,7 +205,7 @@ This sets the pin to be used for serial communication. If you're not using seria
However, if you are using serial and I<sup>2</sup>C on the board, you will need to set this, and to something other than D0 and D1 (as these are used for I<sup>2</sup>C communication).
```c
-#define SELECT_SOFT_SERIAL_SPEED {#}`
+#define SELECT_SOFT_SERIAL_SPEED {#}
```
If you're having issues with serial communication, you can change this value, as it controls the communication speed for serial. The default is 1, and the possible values are:
diff --git a/docs/newbs_building_firmware_workflow.md b/docs/newbs_building_firmware_workflow.md
@@ -143,13 +143,13 @@ Replace `username.json` with the JSON file name that was downloaded from [QMK Co
If you have completed all steps correctly, the folder `qmk_keymap/` will contain the following files:
```
-|-- .github
-| `-- workflows
-| `-- build.yml
-|-- rules.mk
-|-- config.h
-|-- source.c
-|-- username.json
+├── .github
+│ └── workflows
+│ └── build.yml
+├── rules.mk
+├── config.h
+├── source.c
+└── username.json
```
To commit and push them into GitHub, run the following commands (replacing `gh-username` with your GitHub user name):
