Merge pull request #4683 from srg74/main

Fixing markdownlint errors

usermods/BH1750_v2/readme.md

@@ -4,6 +4,7 @@ This usermod will read from an ambient light sensor like the BH1750.
 The luminance is displayed in both the Info section of the web UI, as well as published to the `/luminance` MQTT topic if enabled.
 
 ## Dependencies
+
 - Libraries
   - `claws/BH1750 @^1.2.0`
   - This must be added under `lib_deps` in your `platformio.ini` (or `platformio_override.ini`).
@@ -24,23 +25,30 @@ lib_deps =
 ```
 
 ### Configuration Options
+
 The following settings can be set at compile-time but are configurable on the usermod menu (except First Measurement time):
-*   `USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL` - the max number of milliseconds between measurements, defaults to 10000ms
+
-*   `USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL` - the min number of milliseconds between measurements, defaults to 500ms
+- `USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL` - the max number of milliseconds between measurements, defaults to 10000ms
-*   `USERMOD_BH1750_OFFSET_VALUE` - the offset value to report on, defaults to 1
+- `USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL` - the min number of milliseconds between measurements, defaults to 500ms
-*   `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
+- `USERMOD_BH1750_OFFSET_VALUE` - the offset value to report on, defaults to 1
+- `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
 
 In addition, the Usermod screen allows you to:
+
 - enable/disable the usermod
 - Enable Home Assistant Discovery of usermod
 - Configure the SCL/SDA pins
 
 ## API
+
 The following method is available to interact with the usermod from other code modules:
+
 - `getIlluminance` read the brightness from the sensor
 
 ## Change Log
+
 Jul 2022
+
 - Added Home Assistant Discovery
 - Implemented PinManager to register pins
 - Made pins configurable in usermod menu

usermods/PWM_fan/readme.md

@@ -40,6 +40,9 @@ If the fan speed is unlocked, it will revert to temperature controlled speed on
 ## Change Log
 
 2021-10
+
 * First public release
+
 2022-05
+
 * Added JSON API call to allow changing of speed

usermods/project_cars_shiftlight/readme.md

@@ -1,11 +1,11 @@
-### Shift Light for Project Cars
+# Shift Light for Project Cars
 
 Turn your WLED lights into a rev light and shift indicator for Project Cars.
 It's easy to use.
 
-1. Make sure your WLED device and your PC/console are on the same network and can talk to each other
+_1._ Make sure your WLED device and your PC/console are on the same network and can talk to each other
 
-2. Go to the gameplay settings menu in PCARS and enable UDP. There are 9 numbers you can choose from. This is the refresh rate. The lower the number, the better. However, you might run into problems at faster rates.
+_2._ Go to the gameplay settings menu in PCARS and enable UDP. There are 9 numbers you can choose from. This is the refresh rate. The lower the number, the better. However, you might run into problems at faster rates.
 
 | Number | Updates/Second |
 | ------ | -------------- |
@@ -19,5 +19,5 @@ It's easy to use.
 | 8      | 05             |
 | 9      | 1              |
 
-3. Once you enter a race, WLED should automatically shift to PCARS mode.
+_3._ Once you enter a race, WLED should automatically shift to PCARS mode.
-4. Done.
+_4._ Done.

usermods/readme.md

@@ -1,4 +1,4 @@
-### Usermods
+# Usermods
 
 This folder serves as a repository for usermods (custom `usermod.cpp` files)!
 
@@ -6,11 +6,11 @@ If you have created a usermod you believe is useful (for example to support a pa
 
 In order for other people to be able to have fun with your usermod, please keep these points in mind:
 
--   Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)  
+* Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)  
--   Include your custom files 
+* Include your custom files 
--   If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take  
+* If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take  
--   Create a pull request!  
+* Create a pull request!  
--   If your feature is useful for the majority of WLED users, I will consider adding it to the base code!  
+* If your feature is useful for the majority of WLED users, I will consider adding it to the base code!  
 
 While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.  
 I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.

usermods/sht/readme.md

@@ -1,14 +1,17 @@
 # SHT
+
 Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85
 
 ## Requirements
-* "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
+
+* "SHT85" by Rob Tillaart, v0.2 or higher: <https://github.com/RobTillaart/SHT85>
 
 ## Usermod installation
 Simply copy the below block (build task) to your `platformio_override.ini` and compile WLED using this new build task. Or use an existing one, add the buildflag `-D USERMOD_SHT` and the below library dependencies.
 
 ESP32:
-```
+
+```ini
 [env:custom_esp32dev_usermod_sht]
 extends = env:esp32dev
 build_flags = ${common.build_flags_esp32}
@@ -18,7 +21,8 @@ lib_deps = ${esp32.lib_deps}
 ```
 
 ESP8266:
-```
+
+```ini
 [env:custom_d1_mini_usermod_sht]
 extends = env:d1_mini
 build_flags = ${common.build_flags_esp8266}
@@ -28,13 +32,17 @@ lib_deps = ${esp8266.lib_deps}
 ```
 
 ## MQTT Discovery for Home Assistant
+
 If you're using Home Assistant and want to have the temperature and humidity available as entities in HA, you can tick the "Add-To-Home-Assistant-MQTT-Discovery" option in the usermod settings. If you have an MQTT broker configured under "Sync Settings" and it is connected, the mod will publish the auto discovery message to your broker and HA will instantly find it and create an entity each for the temperature and humidity.
 
 ### Publishing readings via MQTT
+
 Regardless of having MQTT discovery ticked or not, the mod will always report temperature and humidity to the WLED MQTT topic of that instance, if you have a broker configured and it's connected.
 
 ## Configuration
+
 Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D USERMOD_SHT`, you will see the config for it there:
+
 * SHT-Type:
   * What it does: Select the SHT sensor type you want to use
   * Possible values: SHT30, SHT31, SHT35, SHT85
@@ -49,8 +57,11 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
   * Default: Disabled
 
 ## Change log
+
 2022-12
+
 * First implementation.
 
 ## Credits
-ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG
+
+ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: <https://discord.gg/WdbAauG>

usermods/usermod_v2_auto_save/readme.md

@@ -2,6 +2,7 @@
 
 v2 Usermod to automatically save settings
 to preset number AUTOSAVE_PRESET_NUM after a change to any of:
+
 * brightness
 * effect speed
 * effect intensity
@@ -19,7 +20,7 @@ Note: WLED doesn't respect the brightness of the preset being auto loaded, so th
 
 ## Installation
 
-Copy and update the example `platformio_override.ini.sample` 
+Copy and update the example `platformio_override.ini.sample`
 from the Rotary Encoder UI usermode folder to the root directory of your particular build.
 This file should be placed in the same directory as `platformio.ini`.
 
@@ -50,6 +51,9 @@ Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.
 ## Change Log
 
 2021-02
+
 * First public release
+
 2021-04
+
 * Adaptation for runtime configuration.

usermods/usermod_v2_word_clock/readme.md

@@ -1,14 +1,15 @@
 # Word Clock Usermod V2
 
-This usermod drives an 11x10 pixel matrix wordclock with WLED. There are 4 additional dots for the minutes. 
+This usermod drives an 11x10 pixel matrix wordclock with WLED. There are 4 additional dots for the minutes.
 The visualisation is described by 4 masks with LED numbers (single dots for minutes, minutes, hours and "clock"). The index of the LEDs in the masks always starts at 0, even if the ledOffset is not 0.
 There are 3 parameters that control behavior:
- 
+
 active: enable/disable usermod
 diplayItIs: enable/disable display of "Es ist" on the clock
 ledOffset: number of LEDs before the wordclock LEDs
 
-### Update for alternative wiring pattern
+## Update for alternative wiring pattern
+
 Based on this fantastic work I added an alternative wiring pattern.
 The original used a long wire to connect DO to DI, from one line to the next line.
 
@@ -17,10 +18,9 @@ With this method, every other line was inverted and showed the wrong letter.
 
 I added a switch in usermod called "meander wiring?" to enable/disable the alternate wiring pattern.
 
-
 ## Installation
 
-Copy and update the example `platformio_override.ini.sample` 
+Copy and update the example `platformio_override.ini.sample`
 from the Rotary Encoder UI usermod folder to the root directory of your particular build.
 This file should be placed in the same directory as `platformio.ini`.