From 42acfdc1cffc0dbcd51b367b11d42a0caee9ee2e Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Mon, 11 Oct 2021 03:24:33 -0500 Subject: [PATCH] linting and misc add markdownlint.jsonc --- .github/ISSUE_TEMPLATE/bug-error-found-in-the-guide-.md | 2 +- .markdownlint.jsonc | 8 ++++++++ docs/Downloaders/SABnzbd/Basic-Setup.md | 2 +- docs/Hardlinks/Check-if-hardlinks-are-working.md | 1 + docs/Hardlinks/Examples.md | 2 +- docs/Hardlinks/How-to-setup-for/Synology.md | 2 +- docs/Hardlinks/How-to-setup-for/Unraid.md | 2 +- docs/Misc/How-to-setup-Torguard-for-port-forwarding.md | 4 ++-- docs/Plex/index.md | 2 +- docs/Radarr/Radarr-recommended-naming-scheme.md | 4 ++-- docs/Radarr/Radarr-remote-path-mapping.md | 2 +- docs/Radarr/Radarr-setup-custom-formats.md | 4 ++-- docs/Sonarr/Sonarr-Release-Profile-RegEx.md | 2 +- docs/Sonarr/Sonarr-recommended-naming-scheme.md | 4 ++-- docs/thnx.md | 3 +-- 15 files changed, 26 insertions(+), 18 deletions(-) create mode 100644 .markdownlint.jsonc diff --git a/.github/ISSUE_TEMPLATE/bug-error-found-in-the-guide-.md b/.github/ISSUE_TEMPLATE/bug-error-found-in-the-guide-.md index a71a1d383..93d132ab1 100644 --- a/.github/ISSUE_TEMPLATE/bug-error-found-in-the-guide-.md +++ b/.github/ISSUE_TEMPLATE/bug-error-found-in-the-guide-.md @@ -7,7 +7,7 @@ assignees: TRaSH- --- -** Which Guide ** +**Which Guide** Please add which Guide you found a Bug/Error with. **Describe the Error in the Guide** diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 000000000..31f2f65a4 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,8 @@ +{ + "default": true, + "MD013": false, + "MD033": false, + "MD024": false, + "MD028": false, + "MD046": fenced +} diff --git a/docs/Downloaders/SABnzbd/Basic-Setup.md b/docs/Downloaders/SABnzbd/Basic-Setup.md index e2e3786c0..ce03a6b00 100644 --- a/docs/Downloaders/SABnzbd/Basic-Setup.md +++ b/docs/Downloaders/SABnzbd/Basic-Setup.md @@ -146,4 +146,4 @@ Being that Sonarr/Radarr only looks at the last xx amount in the queue/history. ------ -Thnx to [fryfrog](https://github.com/fryfrog){:target="_blank" rel="noopener noreferrer"} for helping me with the settings and providing the info needed to create this Guide. +Thanks to [fryfrog](https://github.com/fryfrog){:target="_blank" rel="noopener noreferrer"} for helping me with the settings and providing the info needed to create this Guide. diff --git a/docs/Hardlinks/Check-if-hardlinks-are-working.md b/docs/Hardlinks/Check-if-hardlinks-are-working.md index ac70f5027..b04d43473 100644 --- a/docs/Hardlinks/Check-if-hardlinks-are-working.md +++ b/docs/Hardlinks/Check-if-hardlinks-are-working.md @@ -7,6 +7,7 @@ You can use 2 options to check if you got working hardlinks. *Both ways requires you to login to your terminal with PuTTY or similar software.* --- + ## Usenet !!! note "" diff --git a/docs/Hardlinks/Examples.md b/docs/Hardlinks/Examples.md index 4b9876686..5901f4431 100644 --- a/docs/Hardlinks/Examples.md +++ b/docs/Hardlinks/Examples.md @@ -102,4 +102,4 @@ ------ -Big Thnx to [fryfrog](https://github.com/fryfrog){:target="_blank" rel="noopener noreferrer"} for his [Docker Guide](https://wiki.servarr.com/Docker_Guide){:target="_blank" rel="noopener noreferrer"} that I used as basis for this guide. +Big Thanks to [fryfrog](https://github.com/fryfrog){:target="_blank" rel="noopener noreferrer"} for his [Docker Guide](https://wiki.servarr.com/docker-guide){:target="_blank" rel="noopener noreferrer"} that I used as basis for this guide. diff --git a/docs/Hardlinks/How-to-setup-for/Synology.md b/docs/Hardlinks/How-to-setup-for/Synology.md index bedf10bcf..066e4852e 100644 --- a/docs/Hardlinks/How-to-setup-for/Synology.md +++ b/docs/Hardlinks/How-to-setup-for/Synology.md @@ -6,7 +6,7 @@ This works like 10x faster then the GUI and after adding it shows up in the GUI. - Thnx to faxity for the initial compose that I used to create the Synology Guide. + Thanks to faxity for the initial compose that I used to create the Synology Guide. We need to get some information that we need later to setup the docker-compose file. diff --git a/docs/Hardlinks/How-to-setup-for/Unraid.md b/docs/Hardlinks/How-to-setup-for/Unraid.md index e09f878f5..b6df33fdf 100644 --- a/docs/Hardlinks/How-to-setup-for/Unraid.md +++ b/docs/Hardlinks/How-to-setup-for/Unraid.md @@ -196,7 +196,7 @@ data !!! tip "" - Big Thnx to IBRACORP for noticing this Guide and creating a Video covering this unraid section. + Big Thanks to IBRACORP for noticing this Guide and creating a Video covering this unraid section. The reason why I added the video to the end is because I want the user to actually learn and understand why it's recommended to use this folder structure, before going straight to the YouTube video. diff --git a/docs/Misc/How-to-setup-Torguard-for-port-forwarding.md b/docs/Misc/How-to-setup-Torguard-for-port-forwarding.md index 5f75b8ffd..19fcfe2a9 100644 --- a/docs/Misc/How-to-setup-Torguard-for-port-forwarding.md +++ b/docs/Misc/How-to-setup-Torguard-for-port-forwarding.md @@ -200,6 +200,6 @@ Choose your preferred VPN Tunnel type. ------ -THNX: +Thanks: -A big thnx to [mrhotio](https://github.com/mrhotio) for his excellent instructions on how to setup WireGuard for TorGuard. +A big Thanks to [mrhotio](https://github.com/mrhotio) for his excellent instructions on how to setup WireGuard for TorGuard. diff --git a/docs/Plex/index.md b/docs/Plex/index.md index aaf75d3f4..af9a1a38d 100644 --- a/docs/Plex/index.md +++ b/docs/Plex/index.md @@ -2,4 +2,4 @@ Here I will start adding Tips and Info for plex -![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fplex%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) \ No newline at end of file +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fplex%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) diff --git a/docs/Radarr/Radarr-recommended-naming-scheme.md b/docs/Radarr/Radarr-recommended-naming-scheme.md index adcc2d171..c535e398a 100644 --- a/docs/Radarr/Radarr-recommended-naming-scheme.md +++ b/docs/Radarr/Radarr-recommended-naming-scheme.md @@ -100,6 +100,6 @@ RESULT: ------ -THNX: +Thanks: -A big thnx to [fryfrog](https://github.com/fryfrog) and [rg9400](https://github.com/rg9400) for the suggestions. +A big Thanks to [fryfrog](https://github.com/fryfrog) and [rg9400](https://github.com/rg9400) for the suggestions. diff --git a/docs/Radarr/Radarr-remote-path-mapping.md b/docs/Radarr/Radarr-remote-path-mapping.md index f0598088d..ee763685b 100644 --- a/docs/Radarr/Radarr-remote-path-mapping.md +++ b/docs/Radarr/Radarr-remote-path-mapping.md @@ -13,7 +13,7 @@ Remote Path Mapping acts as a dumb find `Remote Path` and replace with `Local Pa !!! note If you run dockers it would be smarter to fix the problem at the source what's causing the actual issue. - - [Radarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/Docker_Guide#Consistent_and_well_planned_paths) + - [Radarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) - [TRaSH Guides](/Misc/how-to-set-up-hardlinks-and-atomic-moves/) diff --git a/docs/Radarr/Radarr-setup-custom-formats.md b/docs/Radarr/Radarr-setup-custom-formats.md index 365f4e753..9c25ec500 100644 --- a/docs/Radarr/Radarr-setup-custom-formats.md +++ b/docs/Radarr/Radarr-setup-custom-formats.md @@ -328,6 +328,6 @@ Because I'm to lazy to calculate the maximum for every of my used Quality Profil Use x265 only for 4k releases and the [720/1080p no x265](/Radarr/Radarr-collection-of-custom-formats/#x265-7201080p){:target="_blank" rel="noopener noreferrer"} makes sure you still can get the x265 releases. -## THNX +## Thanks -A big thnx to [rg9400](https://github.com/rg9400) for providing me with info needed to create the Tips section. +A big Thanks to [rg9400](https://github.com/rg9400) for providing me with info needed to create the Tips section. diff --git a/docs/Sonarr/Sonarr-Release-Profile-RegEx.md b/docs/Sonarr/Sonarr-Release-Profile-RegEx.md index 8a880f50a..0714d45ff 100644 --- a/docs/Sonarr/Sonarr-Release-Profile-RegEx.md +++ b/docs/Sonarr/Sonarr-Release-Profile-RegEx.md @@ -499,7 +499,7 @@ When you've done it correctly it will look something like this. This list is made by collecting information from Sonarr Discord Channel, and personal testing and a few others that helped. -So I want to thnx everyone who helped to make this list possible, for privacy reasons I decided not to add the names/nick of the persons. +So I want to Thanks everyone who helped to make this list possible, for privacy reasons I decided not to add the names/nick of the persons. If you want to be mentioned please message me on discord, including a link for proof to what part you want to be credited. diff --git a/docs/Sonarr/Sonarr-recommended-naming-scheme.md b/docs/Sonarr/Sonarr-recommended-naming-scheme.md index 9603022e3..3284ea216 100644 --- a/docs/Sonarr/Sonarr-recommended-naming-scheme.md +++ b/docs/Sonarr/Sonarr-recommended-naming-scheme.md @@ -192,6 +192,6 @@ The filename can be Obscured where the Release naming isn't especially when you ------ -THNX: +Thanks: -A big thnx to [fryfrog](https://github.com/fryfrog), [rg9400](https://github.com/rg9400) and [bakerboy448](https://github.com/bakerboy448) for the suggestions. +A big Thanks to [fryfrog](https://github.com/fryfrog), [rg9400](https://github.com/rg9400) and [bakerboy448](https://github.com/bakerboy448) for the suggestions. diff --git a/docs/thnx.md b/docs/thnx.md index 6e450312e..07c925a3a 100644 --- a/docs/thnx.md +++ b/docs/thnx.md @@ -1,3 +1,2 @@ -# Thnx for the Coffee +# Thanks for the Coffee -![thnx-for-the-coffee.jpg](img/thnx-for-the-coffee.jpg)