diff --git a/.cache/plugin/social/d89136461f3bc32b03eadfb485d806b5.png b/.cache/plugin/social/d89136461f3bc32b03eadfb485d806b5.png new file mode 100644 index 0000000..ce3904f Binary files /dev/null and b/.cache/plugin/social/d89136461f3bc32b03eadfb485d806b5.png differ diff --git a/docs/Introduction.md b/docs/Introduction.md new file mode 100644 index 0000000..1f3d73d --- /dev/null +++ b/docs/Introduction.md @@ -0,0 +1,40 @@ +

+ Discord + GitHub Actions Workflow Status + GitHub Release + GitHub commits since latest release + GitHub Repo stars + Docker Pulls + GitHub commit activity + GitHub Issues or Pull Requests + GitHub Issues or Pull Requests + GitHub Sponsors + Static Badge + GitHub License +

+ + + +**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 diff --git a/docs/index.md b/docs/index.md index 1f3d73d..70f8912 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,40 +1,4 @@ -

- Discord - GitHub Actions Workflow Status - GitHub Release - GitHub commits since latest release - GitHub Repo stars - Docker Pulls - GitHub commit activity - GitHub Issues or Pull Requests - GitHub Issues or Pull Requests - GitHub Sponsors - Static Badge - GitHub License -

- - - -**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 +--- diff --git a/docs/overrides/homepage/home.html b/docs/overrides/homepage/home.html new file mode 100644 index 0000000..4495a29 --- /dev/null +++ b/docs/overrides/homepage/home.html @@ -0,0 +1,261 @@ + + +{% extends "main.html" %} +{% block tabs %} +{{ super() }} + + + + + + + +
+
+
+ + +
+

The Perfect Media Janitor

+

Documentation for the wildly popular Maintainerr project. +

+ + + Get Started + + Introduction +
+
+
+
+

Docker Run - Quick Start

+
+
+ 
+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
+
+
+
+
+
+ +{% endblock %} +{% block content %}{% endblock %} +{% block footer %}{% endblock %} diff --git a/docs/overrides/homepage/main.html b/docs/overrides/homepage/main.html new file mode 100644 index 0000000..b037806 --- /dev/null +++ b/docs/overrides/homepage/main.html @@ -0,0 +1,8 @@ + + +{% extends "base.html" %} + +{% block extrahead %} + + +{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 94d5178..9f3560c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -173,6 +173,7 @@ nav: - Rules Glossary: Glossary.md - Collections: Collections.md - Community: + - Introduction.md - Contributing.md - Guides: - Tutorials: @@ -180,3 +181,21 @@ nav: - 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"