diff --git a/docs/.pages b/docs/.pages index c33876dcb..00ce8c905 100644 --- a/docs/.pages +++ b/docs/.pages @@ -4,7 +4,7 @@ nav: - Sonarr - Bazarr - Notifiarr - - NZBGet + - Downloaders - Plex - Misc - Hardlinks diff --git a/docs/Downloaders/.pages b/docs/Downloaders/.pages new file mode 100644 index 000000000..0ef29032d --- /dev/null +++ b/docs/Downloaders/.pages @@ -0,0 +1,7 @@ +nav: + - Home: index.md + - NZBGet + - SABnzbd + - qBittorrent + - Deluge + - ruTorrent diff --git a/docs/Downloaders/Deluge/index.md b/docs/Downloaders/Deluge/index.md new file mode 100644 index 000000000..f2ced3428 --- /dev/null +++ b/docs/Downloaders/Deluge/index.md @@ -0,0 +1 @@ +# Deluge Placeholder diff --git a/docs/NZBGet/How-to-setup-NZBGet.md b/docs/Downloaders/NZBGet/How-to-setup-NZBGet.md similarity index 100% rename from docs/NZBGet/How-to-setup-NZBGet.md rename to docs/Downloaders/NZBGet/How-to-setup-NZBGet.md diff --git a/docs/NZBGet/images/categories.png b/docs/Downloaders/NZBGet/images/categories.png similarity index 100% rename from docs/NZBGet/images/categories.png rename to docs/Downloaders/NZBGet/images/categories.png diff --git a/docs/NZBGet/images/checkAndRepair.png b/docs/Downloaders/NZBGet/images/checkAndRepair.png similarity index 100% rename from docs/NZBGet/images/checkAndRepair.png rename to docs/Downloaders/NZBGet/images/checkAndRepair.png diff --git a/docs/NZBGet/images/extScripts.png b/docs/Downloaders/NZBGet/images/extScripts.png similarity index 100% rename from docs/NZBGet/images/extScripts.png rename to docs/Downloaders/NZBGet/images/extScripts.png diff --git a/docs/NZBGet/images/incoming.png b/docs/Downloaders/NZBGet/images/incoming.png similarity index 100% rename from docs/NZBGet/images/incoming.png rename to docs/Downloaders/NZBGet/images/incoming.png diff --git a/docs/NZBGet/images/logging.png b/docs/Downloaders/NZBGet/images/logging.png similarity index 100% rename from docs/NZBGet/images/logging.png rename to docs/Downloaders/NZBGet/images/logging.png diff --git a/docs/NZBGet/images/newsservers.png b/docs/Downloaders/NZBGet/images/newsservers.png similarity index 100% rename from docs/NZBGet/images/newsservers.png rename to docs/Downloaders/NZBGet/images/newsservers.png diff --git a/docs/NZBGet/images/paths.png b/docs/Downloaders/NZBGet/images/paths.png similarity index 100% rename from docs/NZBGet/images/paths.png rename to docs/Downloaders/NZBGet/images/paths.png diff --git a/docs/NZBGet/images/queue.png b/docs/Downloaders/NZBGet/images/queue.png similarity index 100% rename from docs/NZBGet/images/queue.png rename to docs/Downloaders/NZBGet/images/queue.png diff --git a/docs/NZBGet/images/unpack.png b/docs/Downloaders/NZBGet/images/unpack.png similarity index 100% rename from docs/NZBGet/images/unpack.png rename to docs/Downloaders/NZBGet/images/unpack.png diff --git a/docs/NZBGet/index.md b/docs/Downloaders/NZBGet/index.md similarity index 100% rename from docs/NZBGet/index.md rename to docs/Downloaders/NZBGet/index.md diff --git a/docs/NZBGet/scripts/Clean/Clean.py b/docs/Downloaders/NZBGet/scripts/Clean/Clean.py similarity index 100% rename from docs/NZBGet/scripts/Clean/Clean.py rename to docs/Downloaders/NZBGet/scripts/Clean/Clean.py diff --git a/docs/NZBGet/scripts/Clean/README.md b/docs/Downloaders/NZBGet/scripts/Clean/README.md similarity index 100% rename from docs/NZBGet/scripts/Clean/README.md rename to docs/Downloaders/NZBGet/scripts/Clean/README.md diff --git a/docs/NZBGet/scripts/HashRenamer/HashRenamer.py b/docs/Downloaders/NZBGet/scripts/HashRenamer/HashRenamer.py similarity index 100% rename from docs/NZBGet/scripts/HashRenamer/HashRenamer.py rename to docs/Downloaders/NZBGet/scripts/HashRenamer/HashRenamer.py diff --git a/docs/NZBGet/scripts/HashRenamer/README.md b/docs/Downloaders/NZBGet/scripts/HashRenamer/README.md similarity index 100% rename from docs/NZBGet/scripts/HashRenamer/README.md rename to docs/Downloaders/NZBGet/scripts/HashRenamer/README.md diff --git a/docs/NZBGet/scripts/WtFnZb-Renamer/README.md b/docs/Downloaders/NZBGet/scripts/WtFnZb-Renamer/README.md similarity index 100% rename from docs/NZBGet/scripts/WtFnZb-Renamer/README.md rename to docs/Downloaders/NZBGet/scripts/WtFnZb-Renamer/README.md diff --git a/docs/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py b/docs/Downloaders/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py similarity index 100% rename from docs/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py rename to docs/Downloaders/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py diff --git a/docs/NZBGet/scripts/index.md b/docs/Downloaders/NZBGet/scripts/index.md similarity index 57% rename from docs/NZBGet/scripts/index.md rename to docs/Downloaders/NZBGet/scripts/index.md index 22862915d..a4e0e5c3d 100644 --- a/docs/NZBGet/scripts/index.md +++ b/docs/Downloaders/NZBGet/scripts/index.md @@ -7,7 +7,7 @@ Cleans the NZB name by removing the retagged stuff (-Obfuscated, -postbox, etc). ??? example "Script" ```python - [[% filter indent(width=4) %]][[% include 'NZBGet/scripts/Clean/Clean.py' %]][[% endfilter %]] + [[% filter indent(width=4) %]][[% include 'Downloaders/NZBGet/scripts/Clean/Clean.py' %]][[% endfilter %]] ``` ## [HashRenamer](HashRenamer/README.md) @@ -17,7 +17,7 @@ Renames hashed media files to match the source NZB. ??? example "Script" ```python - [[% filter indent(width=4) %]][[% include 'NZBGet/scripts/HashRenamer/HashRenamer.py' %]][[% endfilter %]] + [[% filter indent(width=4) %]][[% include 'Downloaders/NZBGet/scripts/HashRenamer/HashRenamer.py' %]][[% endfilter %]] ``` ## [WtFnZb-Renamer](WtFnZb-Renamer/README.md) @@ -27,5 +27,5 @@ This extensions extracts obfuscated filenames from .nzb files ??? example "Script" ```python - [[% filter indent(width=4) %]][[% include 'NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py' %]][[% endfilter %]] + [[% filter indent(width=4) %]][[% include 'Downloaders/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py' %]][[% endfilter %]] ``` diff --git a/docs/Downloaders/SABnzbd/index.md b/docs/Downloaders/SABnzbd/index.md new file mode 100644 index 000000000..70b3e1cb1 --- /dev/null +++ b/docs/Downloaders/SABnzbd/index.md @@ -0,0 +1 @@ +# SABnzbd Placeholder diff --git a/docs/Downloaders/index.md b/docs/Downloaders/index.md new file mode 100644 index 000000000..4854bcb89 --- /dev/null +++ b/docs/Downloaders/index.md @@ -0,0 +1,27 @@ +# Download Clients + +Here you will find Guides for several Download Clients. + +## Usenet Clients + +### NZBGet + +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fnzbget%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) + +### SABnzbd + +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fsabnzbd%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) + +## Torrent Clients + +### qBittorrent + +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fqbittorrent%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) + +### Deluge + +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fdeluge%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) + +### ruTorrent + +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fruotrrent%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) diff --git a/docs/Downloaders/qBittorrent/index.md b/docs/Downloaders/qBittorrent/index.md new file mode 100644 index 000000000..59ab011c0 --- /dev/null +++ b/docs/Downloaders/qBittorrent/index.md @@ -0,0 +1 @@ +# qBittorrent Placeholder diff --git a/docs/Downloaders/ruTorrent/index.md b/docs/Downloaders/ruTorrent/index.md new file mode 100644 index 000000000..f641fbf09 --- /dev/null +++ b/docs/Downloaders/ruTorrent/index.md @@ -0,0 +1 @@ +# ruTorrent Placeholder diff --git a/mkdocs.yml b/mkdocs.yml index 7b32e73a1..24a559eda 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,6 +60,8 @@ plugins: Misc/Discord-Notifier-Basic-Setup.md: Notifiarr/Quick-Start.md Misc/Discord-Notifiarr-Setup.md: Notifiarr/Quick-Start.md Misc/how-to-set-up-hardlinks-and-atomic-moves.md: Hardlinks/Hardlinks-and-Instant-Moves.md + NZBGet/How-to-setup-NZBGet.md: Downloaders/NZBGet/How-to-setup-NZBGet.md + NZBGet/scripts/index.md: Downloaders/NZBGet/scripts/index.md hardlinks.md: Hardlinks/Hardlinks-and-Instant-Moves.md hardlink.md: Hardlinks/Hardlinks-and-Instant-Moves.md check-hardlinks.md: Hardlinks/Check-if-hardlinks-are-working.md