Adding HomePage and moving main page to Introductions

docs/Introduction.md

@@ -0,0 +1,40 @@
+<p align="center" >
+  <a href="https://discord.gg/WP4ZW2QYwk" target="blank"><img alt="Discord" src="https://img.shields.io/discord/1152219249549512724?style=flat&logo=discord&logoColor=white&label=Maintainerr"></a>
+  <picture><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/jorenn92/maintainerr/.github%2Fworkflows%2Fbuild.yml?branch=main&style=flat&logo=github&label=Latest%20Build"></picture>
+  <a href="https://github.com/jorenn92/Maintainerr/releases" target="blank"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=Latest%20Release"></a>
+  <picture><img alt="GitHub commits since latest release" src="https://img.shields.io/github/commits-since/jorenn92/maintainerr/latest?style=flat&logo=github&logoColor=white"></picture>
+  <picture><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=Stars"></picture>
+  <a href="https://hub.docker.com/r/jorenn92/maintainerr" target="blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/jorenn92/maintainerr?style=flat&logo=docker&logoColor=white&label=Docker%20Pulls"></a>
+  <picture><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=COMMITS"></picture>
+  <picture><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-closed/jorenn92/maintainerr?style=flat&logo=github&logoColor=white"></picture>
+  <picture><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/jorenn92/maintainerr?style=flat&logo=github&logoColor=white"></picture>
+  <a href="https://github.com/sponsors/jorenn92" target="blank"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/JORENN92?style=flat&logo=github%20sponsors&logoColor=white&label=sponsors"></a>
+  <a href="https://ko-fi.com/maintainerr_app" target="blank"><img alt="Static Badge" src="https://img.shields.io/badge/DONATE-kofi-red?style=flat&logo=ko-fi&logoColor=white"></a>
+  <picture><img alt="GitHub License" src="https://img.shields.io/github/license/jorenn92/maintainerr?style=flat"></picture>
+</p>
+
+
+
+**Maintainerr** makes managing your media easy. No longer do you have to worry about your precious hard drive space being taken up by Movies and TVShows, that aren't even being watched.
+
+> Maintainerr is beta software, please report any bugs or issues.
+
+## Features
+
+- Make Plex collections from a specific set of rules, defined by you.
+- Configure those rules to match your needs. (i.e. `Plex last viewed 30 days ago`)
+- See an overview of your Plex library contents.
+- Manually add an item to one of the above mentioned collections.
+- Manually exclude an item from one of the collections, even if it meets the rule criteria.
+- Show your new collection on the *Plex Home* screen.
+- Set a number of days the collection will exist before it is deleted.
+- Set Radarr and Sonarr to either **remove** or **unmonitor** media in the collection.
+- Auto clear requests from Overseerr
+- Remove media from disk
+
+Maintainerr supports rules across these apps :
+
+- Plex
+- Overseerr
+- Radarr
+- Sonarr

docs/index.md

@@ -1,40 +1,4 @@
-<p align="center" >
-  <a href="https://discord.gg/WP4ZW2QYwk" target="blank"><img alt="Discord" src="https://img.shields.io/discord/1152219249549512724?style=flat&logo=discord&logoColor=white&label=Maintainerr"></a>
-  <picture><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/jorenn92/maintainerr/.github%2Fworkflows%2Fbuild.yml?branch=main&style=flat&logo=github&label=Latest%20Build"></picture>
-  <a href="https://github.com/jorenn92/Maintainerr/releases" target="blank"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=Latest%20Release"></a>
-  <picture><img alt="GitHub commits since latest release" src="https://img.shields.io/github/commits-since/jorenn92/maintainerr/latest?style=flat&logo=github&logoColor=white"></picture>
-  <picture><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=Stars"></picture>
-  <a href="https://hub.docker.com/r/jorenn92/maintainerr" target="blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/jorenn92/maintainerr?style=flat&logo=docker&logoColor=white&label=Docker%20Pulls"></a>
-  <picture><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/jorenn92/maintainerr?style=flat&logo=github&logoColor=white&label=COMMITS"></picture>
-  <picture><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-closed/jorenn92/maintainerr?style=flat&logo=github&logoColor=white"></picture>
-  <picture><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/jorenn92/maintainerr?style=flat&logo=github&logoColor=white"></picture>
-  <a href="https://github.com/sponsors/jorenn92" target="blank"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/JORENN92?style=flat&logo=github%20sponsors&logoColor=white&label=sponsors"></a>
-  <a href="https://ko-fi.com/maintainerr_app" target="blank"><img alt="Static Badge" src="https://img.shields.io/badge/DONATE-kofi-red?style=flat&logo=ko-fi&logoColor=white"></a>
-  <picture><img alt="GitHub License" src="https://img.shields.io/github/license/jorenn92/maintainerr?style=flat"></picture>
-</p>
-
-
-
-**Maintainerr** makes managing your media easy. No longer do you have to worry about your precious hard drive space being taken up by Movies and TVShows, that aren't even being watched.
-
-> Maintainerr is beta software, please report any bugs or issues.
-
-## Features
-
-- Make Plex collections from a specific set of rules, defined by you.
-- Configure those rules to match your needs. (i.e. `Plex last viewed 30 days ago`)
-- See an overview of your Plex library contents.
-- Manually add an item to one of the above mentioned collections.
-- Manually exclude an item from one of the collections, even if it meets the rule criteria.
-- Show your new collection on the *Plex Home* screen.
-- Set a number of days the collection will exist before it is deleted.
-- Set Radarr and Sonarr to either **remove** or **unmonitor** media in the collection.
-- Auto clear requests from Overseerr
-- Remove media from disk
-
-Maintainerr supports rules across these apps :
-
-- Plex
-- Overseerr
-- Radarr
-- Sonarr
+---
+template: homepage/home.html
+title: Home
+---

docs/overrides/homepage/home.html

@@ -0,0 +1,261 @@
+<!-- Elements added to "home.html" will only be displayed on the home page -->
+
+{% extends "main.html" %}
+{% block tabs %}
+{{ super() }}
+
+<!-- Google Fonts -->
+<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined" rel="stylesheet" />
+
+<!-- Stole this styling from the "up42-py" project (link: https://sdk.up42.com/) -->
+<style>
+
+    .md-main {
+        flex-grow: 0
+    }
+
+    .md-main__inner {
+        display: flex;
+        height: 100%;
+    }
+
+    .tx-container {
+        padding-top: .0rem;
+    }
+
+    .tx-hero {
+        margin: 32px 2.8rem;
+        color: var(--md-primary-bg-color);
+        justify-content: center;
+    }
+
+    .tx-hero h1 {
+        letter-spacing: -.025em;
+    	font-size: 2.9rem;
+    	line-height: 1.25;
+    	color: transparent;
+    	background-clip: text;
+    			--tw-gradient-to: #f8ba53;
+    			--tw-gradient-from: #d97706;
+    	background-image: linear-gradient(to bottom right, var(--tw-gradient-stops));
+    			--tw-gradient-stops: var(--tw-gradient-to), var(--tw-gradient-from), rgba(255, 255, 255, 0.7);
+    	display: block;
+    	margin-bottom: 1rem;
+        font-weight: 700
+    }
+
+    .tx-hero__content {
+        padding-bottom: 1rem;
+        margin: 0 auto;
+    }
+    .md-container {
+        background-image:  linear-gradient(rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 0.5)), url(images/banner3.png);
+	background-repeat: no-repeat;
+        background-position: top;
+	background-size: cover;
+    }		
+
+    .tx-hero .md-button {
+        margin-top: .5rem;
+        margin-right: .5rem;
+        border-radius: 10px;
+        color: var(--md-primary-bg-color)
+    }
+
+    .tx-hero .md-button--primary {
+        background-color: var(--md-primary-bg-color);
+        color: orange;
+        border-color: var(--md-primary-bg-color)
+    }
+
+    .tx-hero .md-button:focus,
+    .tx-hero .md-button:hover {
+        background-color: var(--md-accent-fg-color);
+        color: var(--md-default-bg-color);
+        border-color: var(--md-accent-fg-color)
+    }
+
+    @media screen and (max-width:30em) {
+        .tx-hero h1 {
+            font-size: 1.4rem
+        }
+    }
+
+    @media screen and (min-width:60em) {
+        .md-sidebar--secondary {
+            display: none
+        }
+
+        .tx-hero {
+            display: flex;
+            align-items: center;
+            justify-content: center;
+        }
+
+        .tx-hero__content {
+            max-width: 22rem;
+            margin-top: 3.5rem;
+            margin-bottom: 3.5rem;
+            margin-left: 1.0rem;
+            margin-right: 4.0rem;
+            align-items: center;
+        }
+    }
+
+    @media screen and (min-width:76.25em) {
+        .md-sidebar--primary {
+            display: none
+        }
+
+        .top-hr {
+            width: 100%;
+            display: flex;
+            max-width: 61rem;
+            margin-right: auto;
+            margin-left: auto;
+            padding: 0 .2rem;
+        }
+
+        .bottom-hr {
+            margin-top: 10px;
+            width: 100%;
+            display: flex;
+            max-width: 61rem;
+            margin-right: auto;
+            margin-left: auto;
+            padding: 0 .2rem;
+        }
+
+        .feature-item {
+            flex: 1;
+            min-width: 0;
+        }
+
+        .feature-item:hover {
+            background-color: #526cfe47;
+            border-radius: 3px;
+        }
+    }
+
+    .hr {
+        border-bottom: 1px solid #eee;
+        width: 100%;
+        margin: 20px 0;
+    }
+
+    .text-center {
+        text-align: center;
+        padding-right: 15px;
+        padding-left: 15px;
+        margin-right: auto;
+        margin-left: auto;
+        margin-top: 15px;
+        font-family: 'Lato', sans-serif;
+        font-size: 23px;
+        font-weight: 300;
+        padding-bottom: 10px;
+    }
+
+    .logos {
+        display: flex;
+        align-items: center;
+        justify-content: center;
+        flex-flow: row wrap;
+        margin: 0 auto;
+    }
+
+    .logos img {
+        flex: 1 1 auto;
+        padding: 25px;
+        max-height: 130px;
+        vertical-align: middle;
+    }
+
+    .hr-logos {
+        margin-top: 0;
+        margin-bottom: 30px;
+    }
+
+    .md-footer-meta__inner {
+        display: flex;
+        flex-wrap: wrap;
+        justify-content: space-between;
+        margin-top: 1.0rem;
+    }
+
+    .md-footer-social {
+        padding-top: 20px;
+    }
+/* Styling for Quick Start Area */
+    .quick-start h1 {
+        letter-spacing: -.025em;
+        font-size: .75rem;
+        line-height: 1;
+        text-align: center;
+        color: transparent;
+        background-clip: text;
+                        --tw-gradient-to: #f8ba53;
+                        --tw-gradient-from: #d97706;
+        background-image: linear-gradient(to bottom right, var(--tw-gradient-stops));
+                        --tw-gradient-stops: var(--tw-gradient-to), var(--tw-gradient-from), rgba(255, 255, 255, 0.7);
+        display: block;
+        margin-bottom: 1rem;
+        font-weight: 700        	
+    }
+    .code-content {
+        display: flex;
+	justify-content: center;
+    	max-width: 95rem;
+    	margin-left: auto;
+    	margin-right: auto;
+    }
+    .code-content-box {
+	font-size: .7rem;
+	border-radius: 8px;
+        background-color: rgba(0,0,0,.5);
+        padding: 10px;
+    }
+    .code {
+        padding: 2px;
+    }
+</style>
+<!-- Main site entry button descriptions -->
+<section class="tx-container">
+    <div class="md-grid md-typeset">
+      <div class="tx-hero">
+
+	<!-- Main Tagline -->
+        <div class="tx-hero__content">
+          <h1>The Perfect Media Janitor <svg xmlns="http://www.w3.org/2000/svg" height="48px" viewBox="0 -960 960 960" width="48px" fill="#F19E39"><path d="M160-391h45l23-66h104l24 66h44l-97-258h-46l-97 258Zm81-103 38-107h2l38 107h-78Zm319-80v-48q33-14 67.5-21t72.5-7q26 0 51 4t49 10v44q-24-9-48.5-13.5T700-610q-38 0-73 9.5T560-574Zm0 220v-49q33-13.5 67.5-20.25T700-430q26 0 51 4t49 10v44q-24-9-48.5-13.5T700-390q-38 0-73 9t-67 27Zm0-110v-48q33-14 67.5-21t72.5-7q26 0 51 4t49 10v44q-24-9-48.5-13.5T700-500q-38 0-73 9.5T560-464ZM248-300q53.57 0 104.28 12.5Q403-275 452-250v-427q-45-30-97.62-46.5Q301.76-740 248-740q-38 0-74.5 9.5T100-707v434q31-14 70.5-20.5T248-300Zm264 50q50-25 98-37.5T712-300q38 0 78.5 6t69.5 16v-429q-34-17-71.82-25-37.82-8-76.18-8-54 0-104.5 16.5T512-677v427Zm-30 90q-51-38-111-58.5T248-239q-36.54 0-71.77 9T106-208q-23.1 11-44.55-3Q40-225 40-251v-463q0-15 7-27.5T68-761q42-20 87.39-29.5 45.4-9.5 92.61-9.5 63 0 122.5 17T482-731q51-35 109.5-52T712-800q46.87 0 91.93 9.5Q849-781 891-761q14 7 21.5 19.5T920-714v463q0 27.89-22.5 42.45Q875-194 853-208q-34-14-69.23-22.5Q748.54-239 712-239q-63 0-121 21t-109 58ZM276-495Z"/></svg></h1>
+          <p>Documentation for the wildly popular Maintainerr project.
+</p>
+
+	  <!-- Added Buttons (up to 3) --><a href="Installation" title="Get Started" class="md-button md-button--primary">
+            Get Started
+          </a><a href="Introduction" title="Introduction" class="md-button">
+            Introduction
+          </a></div>
+      </div>
+    </div>
+<div class="quick-start">
+ <h1> Docker Run - Quick Start </h1>
+   <div class="code-content">
+	<div class="code-content-box">
+  	  <pre>
+docker run -d \
+  --name maintainerr \
+  -e TZ=Europe/Brussels \
+  -v ./data:/opt/data \
+  -u 1000:1000 \
+  -p 6246:6246 \ 
+  --restart unless-stopped \
+  ghcr.io/jorenn92/maintainerr:latest
+   	  </pre>
+   	</div>
+  </div>
+</div>
+</section>
+
+{% endblock %}
+{% block content %}{% endblock %}
+{% block footer %}{% endblock %}

docs/overrides/homepage/main.html

@@ -0,0 +1,8 @@
+<!-- Elements added to "main.html" will be displayed on all pages -->
+
+{% extends "base.html" %}
+
+{% block extrahead %}
+    <!-- main.html | Added "navigation.instant" support -->
+    <link rel="canonical" href=".">
+{% endblock %}

mkdocs.yml

@@ -173,10 +173,29 @@ nav:
     - Rules Glossary: Glossary.md
   - Collections: Collections.md
   - Community:
+    - Introduction.md
     - Contributing.md
   - Guides:
     - Tutorials:
       - Tutorials/index.md
       - S01E01: Tutorials/Tutorial_S01E01.md
       - S01E02: Tutorials/Tutorial_S01E02.md
       - S01E03: Tutorials/Tutorial_S01E03.md
+
+# Custom Homepage Elements
+home_cover_image: # This path starts at your root mkdocs directory.
+home_tagline: The Perfect Media Janitor
+home_description: |
+  Documentation for the wildly popular Maintainerr project.
+
+# Gradient Color
+home_gradient_hsla: hsla(0deg,47%,55%,1) # Default Green: hsla(160deg,47%,55%,1)
+
+# Custom Homepage Button(s)
+home_button1_name: Learn More            # Comment this parameter out to remove the button.
+home_button1_url: docs/Introduction.md                       # This path starts at your root mkdocs directory.
+home_button1_theme: md-button md-button--primary # Options: "md-button", "md-button md-button--primary"
+
+home_button2_name: Get Started   # Comment this parameter out to remove the button.
+home_button2_url: Installation    # This path starts at your root mkdocs directory.
+home_button2_theme: md-button # Options: "md-button", "md-button md-button--primary"