Correct Markdown files

Poeschl · Nov 24, 2020 · 5570a72 · 5570a72
1 parent 7bb4bec
commit 5570a72
Show file tree

Hide file tree

Showing 20 changed files with 43 additions and 36 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,5 +2,5 @@
 
 ## Requirements to get Pull Requests accepted
 
-* Passes the build (Including Hadolint and shellcheck)
+* Passes the build (Including Hadolint, shellcheck and markdownlint)
 * Add your changes the the `CHANGELOG.md` and increase the plugin version.
diff --git a/MaryTTS/CHANGELOG.md b/MaryTTS/CHANGELOG.md
@@ -13,7 +13,7 @@
 
 ## 1.0.1 - 2020-10-06
 
- * 🔼 Updated openjdk to `8.252.09-r0`
+* 🔼 Updated openjdk to `8.252.09-r0`
 
 
 ## 1.0.0 - 2020-05-22
@@ -30,6 +30,7 @@
 ## 5.2-3 - 2020-02-24
 
 ### Added
+
 * ➕ Download voice packs according to language on demand
 
 

diff --git a/MaryTTS/DOCS.md b/MaryTTS/DOCS.md
@@ -3,6 +3,7 @@
 ```yaml
 language: de
 ```
+
 ### `language`
 
 One of the languages `de`, `en`, `fr`, `it`, `in`, `tu` and `lu`. This should be the same as you configured in Home Assistant.
@@ -14,4 +15,4 @@ This specifies an url for a custom voice pack. Make sure it is a zip and it cont
 
 # UI
 
-The Demo-UI of MaryTTS can be accessed via `http://<hassio-address>:59125`.
+The Demo-UI of MaryTTS can be accessed via `http://<hassio-address>:59125`.
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
-# Poeschl Home Assistant Supervisor Add-ons 
+# Poeschl Home Assistant Supervisor Add-ons
+
 [![Master build](https://img.shields.io/github/workflow/status/Poeschl/Hassio-Addons/Deploy%20addons?maxAge=3600)](https://github.com/Poeschl/Hassio-Addons/actions?query=workflow%3A%22Deploy+addons%22)
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Poeschl/Hassio-Addons)
 
-My repository with Add-ons for the [Home Assistant (former Hass.io) system](https://www.home-assistant.io/hassio/) 
+My repository with Add-ons for the [Home Assistant (former Hass.io) system](https://www.home-assistant.io/hassio/)
 
 ## Addons
 
@@ -12,16 +13,16 @@ My repository with Add-ons for the [Home Assistant (former Hass.io) system](http
 * pigpio - The pigpio led control for the Raspberry as addon.
 * MPD - A small media player with minimalistic web ui.
 * valetudo-mapper - Valetudo RE Companion for map generation
-* ympd - A very lightweight Web interface for controlling MPD music servers. 
-* Git Exporter - Exports your Home Assistant config to any git repository (secrets check included) 
+* ympd - A very lightweight Web interface for controlling MPD music servers.
+* Git Exporter - Exports your Home Assistant config to any git repository (secrets check included)
 * Syncthing - A de-centralized file syncronisation program. Focused on privacy.
 * OWASP ZAP - A security testing tool with MITM funtionality.
 * mitmproxy - A simple MITM proxy to trace network requests.
 * rsync - Synces folders from Home Assistant to a other machine via rsync and ssh.
 
 More about the Add-ons can be found in their folders.
 
-### 🕸️ Depreciated 
+### 🕸️ Depreciated
 
 On thoes addons will be not developed anymore. Feel free to fork them.
 
@@ -34,9 +35,7 @@ To install those Add-ons add this repository in the Home Assistant Add-on store.
 
 Use the following URL to add this repository:
 
-```
-https://github.com/Poeschl/Hassio-Addons
-```
+`https://github.com/Poeschl/Hassio-Addons`
 
 ### Licence  ![Licence](https://img.shields.io/github/license/Poeschl/Hassio-Addons)
 

diff --git a/git-exporter/DOCS.md b/git-exporter/DOCS.md
@@ -1,7 +1,7 @@
 # Configuration
 
 ```yaml
-repository: 
+repository:
   url: <path to your repository>
   username: user
   password: pass
@@ -25,6 +25,7 @@ exclude:
   - tts/
 dry_run: false
 ```
+
 ### `repository.url`
 
 Any https url to your git repository. (For now _no_ SSH)
@@ -86,6 +87,7 @@ Add pattern for ip and mac addresses to the search.
 The files / folders which should be excluded from the config export.
 
 Following folders and files are excluded from the sync per default:
+
 * `secrets.yaml` (secrets are cleared)
 * `.cloud`
 * `.storage`

diff --git a/mitmproxy/DOCS.md b/mitmproxy/DOCS.md
@@ -10,6 +10,7 @@ The configuration for the mitmproxy can be done via the key-value pairs in the a
 Just add an new pair to the `options` array. _Please add all settings as strings!_
 
 Example:
+
 ```yaml
 options:
   - name: "anticache"
@@ -34,6 +35,7 @@ If you want your own ca signing the traffic the `custom_ca` option can be used.
 For more about the ca certificate requirements see [here](https://docs.mitmproxy.org/stable/concepts-certificates/#ca-and-cert-files)
 
 Example:
+
 ```yaml
 options:
   - name: "anticache"

diff --git a/mopidy/CHANGELOG.md b/mopidy/CHANGELOG.md
@@ -6,6 +6,7 @@
 ## 1.2.2 - 2020-02-09
 
 ### Changed
+
 * 🔨 Start mopidy as `system` startup
 
 
@@ -43,4 +44,4 @@
 
 * ➕ Put mopidy 2.2.3-1 inside the addon.
 * 🔨 Added device mapping for `/dev/snd`
-* 🔨 Adjust mopidy version for aarch64 systems. It will be the version `2.1.0-1` on those systems. 
+* 🔨 Adjust mopidy version for aarch64 systems. It will be the version `2.1.0-1` on those systems.
diff --git a/mopidy/README.md b/mopidy/README.md
@@ -1,4 +1,5 @@
 # 🕸️ Depreciated 🕸️
+
 # Mopidy (Hass.io Addon)
 
 Mopidy with plugins for Hass.io. It enabled the host to play audio.
@@ -16,8 +17,9 @@ It is build with following extensions:
 Mopidy listen on `6680` for http connection, and `6600` for mpd ones.
 
 ## Local Media
+
 The local media can be stored on `/share` (which allow an access through the samba addon).
-By default the directory for media is `/share/mopidy/media`. 
+By default the directory for media is `/share/mopidy/media`.
 
 ## Panel integration
 
@@ -34,6 +36,7 @@ panel_iframe:
 ## Configuration
 
 ### local_scan (bool)
+
 If it is set to true, a local scan is performed on startup. A local scan can also be triggered via the web ui.
 
 ### options (list of dict)
@@ -42,13 +45,13 @@ This object accepts any configuration of the listed extenstions. It can be also
 
 For example: Overwrite the media dir
 
-```
+```json
 {"name": "local/media_dir", "value": "/share/media"}
 ```
 
 ## Default config
 
-```
+```properties
 [core]
 cache_dir = /data/mopidy/cache
 data_dir = /data/mopidy/data_dir

diff --git a/mpd/DOCS.md b/mpd/DOCS.md
@@ -29,7 +29,8 @@ To keep all MPD files in one place I restricted the path prefix to `/share/mpd`
 Please use the default [mpd.conf of the addon](https://github.com/Poeschl/Hassio-Addons/blob/master/mpd/root/etc/mpd.conf) as starting point.
 In case you have issues with your configuration, the [MPD docs](https://www.musicpd.org/doc/html/user.html#configuration) might help you out.
 
-Working example: 
+Working example:
+
 ```yaml
 ...
 custom_config: /share/mpd/mpd.conf
@@ -44,4 +45,4 @@ More see here: [MPD Issue](https://github.com/MusicPlayerDaemon/MPD/issues/218)
 
 ### `Failed to open '/data/database/mpd.db': No such file or directory`
 
-This error is shown on the first start, when no database exists. It will be there on the second run.
+This error is shown on the first start, when no database exists. It will be there on the second run.
diff --git a/picoTTS/CHANGELOG.md b/picoTTS/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## 1.2.0 - 2020-10-21
 
-* ➕ Icon and Logo 
+* ➕ Icon and Logo
 * 🔨 change startup to `application` level
 
 
@@ -36,7 +36,7 @@
 * 🔼 Updated git to `2.24.2-r0`
 
 
-## 1.0.4 - 2019-10-15
+## 1.0.5 - 2019-10-15
 
 * 🔼 Update g++ to `9.2.0-r4`
 * 🔼 Update python to `3.8.2-r0`

diff --git a/picoTTS/DOCS.md b/picoTTS/DOCS.md
@@ -7,15 +7,11 @@ Its available on the HACS for easy integration.
 
 ### Ping
 
-```
-http://ip:59126/ping
-```
+`http://ip:59126/ping`
 
 ### TTS
 
-```
-http://ip:59126/speak?lang=<language>&text=<text>
-```
+`http://ip:59126/speak?lang=<language>&text=<text>`
 
 `language` can be one of those `de-DE, en-GB, en-US, es-ES, fr-FR, it-IT`. If not set it defaults to `en-US`.
-`text` is the text you want to have sinthesized (url-encoded).
+`text` is the text you want to have sinthesized (url-encoded).
diff --git a/picoTTS/README.md b/picoTTS/README.md
@@ -12,4 +12,4 @@ This addon executes the tts engine behind a webservice. It provides support for
 [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
-[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
diff --git a/pigpio/README.md b/pigpio/README.md
@@ -14,4 +14,4 @@ It accesses `/dev/mem` on the host and also has full access to the raw io data.
 [amd64-shield]: https://img.shields.io/badge/amd64-no-red.svg
 [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
-[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
+[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
diff --git a/rsync-local/DOCS.md b/rsync-local/DOCS.md
@@ -42,4 +42,4 @@ Available options: `/dev/sda1`, `/dev/sda2`, `/dev/sdb1`, `/dev/sdb2`
 
 ### `options` (optional)
 
-Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
+Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
diff --git a/rsync-local/README.md b/rsync-local/README.md
@@ -10,4 +10,4 @@ Sync folders to a external usb drive with rsync.
 [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
-[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
diff --git a/rsync/DOCS.md b/rsync/DOCS.md
@@ -55,4 +55,4 @@ The base folder on the remote machine for syncing the folders. Sub-folders with
 
 ### `options` (optional)
 
-Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
+Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
diff --git a/rsync/README.md b/rsync/README.md
@@ -10,4 +10,4 @@ Sync folders to a remote machine via ssh and rsync.
 [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
-[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
diff --git a/valetudo-mapper/CHANGELOG.md b/valetudo-mapper/CHANGELOG.md
@@ -7,7 +7,7 @@
 ## 1.4.0 - 2020-05-29
 
 * 🔼 Updated Valetudo-Mapper to commit `8e23ac2`
-* ➕ Added all missing settings until now 
+* ➕ Added all missing settings until now
 
 ### ⚠️ Breaks existing config
 

diff --git a/ympd/CHANGELOG.md b/ympd/CHANGELOG.md
@@ -13,4 +13,5 @@
 ## 1.0.0 - 2020-02-12
 
 ### Added
+
 * ➕ Add ympd version `1.3.0-r8`
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,4 +42,4 @@ Available options: `/dev/sda1`, `/dev/sda2`, `/dev/sdb1`, `/dev/sdb2`

		### `options` (optional)

		Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
		Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -55,4 +55,4 @@ The base folder on the remote machine for syncing the folders. Sub-folders with

		### `options` (optional)

		Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
		Use your own options for rsync. This string is replacing the default one and get directly to rsync. The default is `-archive --recursive --compress --delete --prune-empty-dirs`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,4 +13,5 @@
		## 1.0.0 - 2020-02-12

		### Added

		* ➕ Add ympd version `1.3.0-r8`