From 2eb0f4b5e63e04313766ccf93456f1b9c11622cc Mon Sep 17 00:00:00 2001 From: TRaSH Date: Fri, 7 Feb 2025 22:23:33 +0100 Subject: [PATCH] Added Downloaders to the to the main index so you can see which guides are available --- docs/Downloaders/Deluge/index.md | 9 +-------- docs/Downloaders/NZBGet/index.md | 4 +--- docs/Downloaders/SABnzbd/index.md | 4 +--- docs/Downloaders/qBittorrent/index.md | 9 +-------- docs/index.md | 12 ++++++++++++ includes/downloaders/deluge-available-guides.md | 10 ++++++++++ includes/downloaders/nzbget-available-guides.md | 5 +++++ includes/downloaders/qbittorrent-available-guides.md | 10 ++++++++++ includes/downloaders/sabnzbd-available-guides.md | 5 +++++ 9 files changed, 46 insertions(+), 22 deletions(-) create mode 100644 includes/downloaders/deluge-available-guides.md create mode 100644 includes/downloaders/nzbget-available-guides.md create mode 100644 includes/downloaders/qbittorrent-available-guides.md create mode 100644 includes/downloaders/sabnzbd-available-guides.md diff --git a/docs/Downloaders/Deluge/index.md b/docs/Downloaders/Deluge/index.md index 1677502e8..55cc5be4d 100644 --- a/docs/Downloaders/Deluge/index.md +++ b/docs/Downloaders/Deluge/index.md @@ -2,11 +2,4 @@ [![version](https://img.shields.io/github/release/linuxserver/docker-deluge.svg?color=4051B5&style=for-the-badge&logo=github){ .off-glb }](https://deluge-torrent.org/){:target="\_blank" rel="noopener noreferrer"} -- [Installing](/Downloaders/Deluge/Installing/) - Installation instructions. -- [Basic-Setup](/Downloaders/Deluge/Basic-Setup/) - Basic set up of the most common settings. -- [Using Labels](/Downloaders/Deluge/Using-Labels/) - Labels are the equivalent of categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use labels in Deluge to keep track of downloads to monitor, rather than watching every torrent in your client. -- [Port forwarding](/Downloaders/Deluge/Port-Forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service. -- Tips - Several tips/tweaks for Deluge. - - [Plugins](/Downloaders/Deluge/Tips/Plugins/) - Here you will find a list of included and available plugins that may be useful. - - [Thin Client](/Downloaders/Deluge/Tips/Thin-Client/) - How to set up the Thin-Client to manage Deluge. - - [unRAID Mover and Deluge](/Downloaders/Deluge/Tips/Unraid-Mover/) - How to move your files from your cache drive to your array when torrents are still seeding. +{! include-markdown "../../../includes/downloaders/deluge-available-guides.md" !} diff --git a/docs/Downloaders/NZBGet/index.md b/docs/Downloaders/NZBGet/index.md index 33377dde1..f71f0c2f3 100644 --- a/docs/Downloaders/NZBGet/index.md +++ b/docs/Downloaders/NZBGet/index.md @@ -2,6 +2,4 @@ [![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){ .off-glb }](https://github.com/nzbgetcom/nzbget){:target="\_blank" rel="noopener noreferrer"} -- [Basic-Setup](/Downloaders/NZBGet/Basic-Setup/) - Basic set up of the most common settings. -- [Path and Categories](/Downloaders/NZBGet/Paths-and-Categories/) - How to set up the categories for NZBGet, and how you can manage and organize your downloads in groups. Starr apps can use the categories in NZBGet to keep track of downloads to monitor, rather than watching every download in your client. -- [Scripts](/Downloaders/NZBGet/scripts/) - A collection of scripts, that only should be used if you have a specific need for it. +{! include-markdown "../../../includes/downloaders/nzbget-available-guides.md" !} diff --git a/docs/Downloaders/SABnzbd/index.md b/docs/Downloaders/SABnzbd/index.md index d3c057d3b..44858610c 100644 --- a/docs/Downloaders/SABnzbd/index.md +++ b/docs/Downloaders/SABnzbd/index.md @@ -2,6 +2,4 @@ [![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){ .off-glb }](https://sabnzbd.org/){:target="\_blank" rel="noopener noreferrer"} -- [Basic-Setup](/Downloaders/SABnzbd/Basic-Setup/) - Basic set up of the most common settings. -- [Path and Categories](/Downloaders/SABnzbd/Paths-and-Categories/) - How to set up the categories for SABnzbd, and how you can manage and organize your downloads in groups. Starr apps can use the categories in SABnzbd to keep track of downloads to monitor, rather than watching every download in your client. -- [Scripts](/Downloaders/SABnzbd/scripts/) - A collection of scripts, that only should be used if you have a specific need for it. +{! include-markdown "../../../includes/downloaders/sabnzbd-available-guides.md" !} diff --git a/docs/Downloaders/qBittorrent/index.md b/docs/Downloaders/qBittorrent/index.md index 73aaed540..ad352581e 100644 --- a/docs/Downloaders/qBittorrent/index.md +++ b/docs/Downloaders/qBittorrent/index.md @@ -2,11 +2,4 @@ [![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){ .off-glb }](https://www.qbittorrent.org/){:target="\_blank" rel="noopener noreferrer"} -- [Basic-Setup](/Downloaders/qBittorrent/Basic-Setup/) - Basic set up of the most common settings. -- [Paths](/Downloaders/qBittorrent/Paths) - Where to set your root download location. -- [How to add Categories](/Downloaders/qBittorrent/How-to-add-categories/) - How to set up the categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use the categories in qBittorrent to keep track of downloads to monitor, rather than watching every torrent in your client. -- [Port forwarding](/Downloaders/qBittorrent/Port-forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service. -- [3rd Party tools](/Downloaders/qBittorrent/3rd-party-tools/) - A collection of 3rd party tools and other related links for qBittorrent. -- Tips - Several tips/tweaks for qBittorrent. - - [unRAID Mover and qBittorrent](/Downloaders/qBittorrent/Tips/How-to-run-the-unRaid-mover-for-qBittorrent/) - How to move your files from your cache drive to your array when torrents are still seeding. - - [Themes and UI Replacements](/Downloaders/qBittorrent/Tips/Themes-and-UI-replacements/) - Themes and UI replacements you can use with qBittorrent. +{! include-markdown "../../../includes/downloaders/qbittorrent-available-guides.md" !} diff --git a/docs/index.md b/docs/index.md index 867b60d06..c6efd4c30 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,6 +42,18 @@ The following guides are available ## Downloaders +- [NZBGet Guides](/Downloaders/NZBGet/){:target="\_blank" rel="noopener noreferrer"} + {! include-markdown "../includes/downloaders/nzbget-available-guides.md" !} + +- [SABnzbd Guides](/Downloaders/SABnzbd/){:target="\_blank" rel="noopener noreferrer"} + {! include-markdown "../includes/downloaders/sabnzbd-available-guides.md" !} + +- [qBittorrent Guides](/Downloaders/qBittorrent/){:target="\_blank" rel="noopener noreferrer"} + {! include-markdown "../includes/downloaders/qbittorrent-available-guides.md" !} + +- [Deluge Guides](/Downloaders/Deluge/){:target="\_blank" rel="noopener noreferrer"} + {! include-markdown "../includes/downloaders/deluge-available-guides.md" !} + ## Plex {! include-markdown "../includes/plex/plex-available-guides.md" !} diff --git a/includes/downloaders/deluge-available-guides.md b/includes/downloaders/deluge-available-guides.md new file mode 100644 index 000000000..9f16df7ef --- /dev/null +++ b/includes/downloaders/deluge-available-guides.md @@ -0,0 +1,10 @@ + +- [Installing](/Downloaders/Deluge/Installing/) - Installation instructions. +- [Basic-Setup](/Downloaders/Deluge/Basic-Setup/) - Basic set up of the most common settings. +- [Using Labels](/Downloaders/Deluge/Using-Labels/) - Labels are the equivalent of categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use labels in Deluge to keep track of downloads to monitor, rather than watching every torrent in your client. +- [Port forwarding](/Downloaders/Deluge/Port-Forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service. +- Tips - Several tips/tweaks for Deluge. + - [Plugins](/Downloaders/Deluge/Tips/Plugins/) - Here you will find a list of included and available plugins that may be useful. + - [Thin Client](/Downloaders/Deluge/Tips/Thin-Client/) - How to set up the Thin-Client to manage Deluge. + - [unRAID Mover and Deluge](/Downloaders/Deluge/Tips/Unraid-Mover/) - How to move your files from your cache drive to your array when torrents are still seeding. + diff --git a/includes/downloaders/nzbget-available-guides.md b/includes/downloaders/nzbget-available-guides.md new file mode 100644 index 000000000..f1562a3ce --- /dev/null +++ b/includes/downloaders/nzbget-available-guides.md @@ -0,0 +1,5 @@ + +- [Basic-Setup](/Downloaders/NZBGet/Basic-Setup/) - Basic set up of the most common settings. +- [Path and Categories](/Downloaders/NZBGet/Paths-and-Categories/) - How to set up the categories for NZBGet, and how you can manage and organize your downloads in groups. Starr apps can use the categories in NZBGet to keep track of downloads to monitor, rather than watching every download in your client. +- [Scripts](/Downloaders/NZBGet/scripts/) - A collection of scripts, that only should be used if you have a specific need for it. + diff --git a/includes/downloaders/qbittorrent-available-guides.md b/includes/downloaders/qbittorrent-available-guides.md new file mode 100644 index 000000000..71d7bb14d --- /dev/null +++ b/includes/downloaders/qbittorrent-available-guides.md @@ -0,0 +1,10 @@ + +- [Basic-Setup](/Downloaders/qBittorrent/Basic-Setup/) - Basic set up of the most common settings. +- [Paths](/Downloaders/qBittorrent/Paths) - Where to set your root download location. +- [How to add Categories](/Downloaders/qBittorrent/How-to-add-categories/) - How to set up the categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use the categories in qBittorrent to keep track of downloads to monitor, rather than watching every torrent in your client. +- [Port forwarding](/Downloaders/qBittorrent/Port-forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service. +- [3rd Party tools](/Downloaders/qBittorrent/3rd-party-tools/) - A collection of 3rd party tools and other related links for qBittorrent. +- Tips - Several tips/tweaks for qBittorrent. + - [unRAID Mover and qBittorrent](/Downloaders/qBittorrent/Tips/How-to-run-the-unRaid-mover-for-qBittorrent/) - How to move your files from your cache drive to your array when torrents are still seeding. + - [Themes and UI Replacements](/Downloaders/qBittorrent/Tips/Themes-and-UI-replacements/) - Themes and UI replacements you can use with qBittorrent. + diff --git a/includes/downloaders/sabnzbd-available-guides.md b/includes/downloaders/sabnzbd-available-guides.md new file mode 100644 index 000000000..ac627695e --- /dev/null +++ b/includes/downloaders/sabnzbd-available-guides.md @@ -0,0 +1,5 @@ + +- [Basic-Setup](/Downloaders/SABnzbd/Basic-Setup/) - Basic set up of the most common settings. +- [Path and Categories](/Downloaders/SABnzbd/Paths-and-Categories/) - How to set up the categories for SABnzbd, and how you can manage and organize your downloads in groups. Starr apps can use the categories in SABnzbd to keep track of downloads to monitor, rather than watching every download in your client. +- [Scripts](/Downloaders/SABnzbd/scripts/) - A collection of scripts, that only should be used if you have a specific need for it. +