Resolve docs release conflicts

.github/workflows/deploy.yml

@@ -1,5 +1,5 @@
 name: Deploy docs to GitHub Pages via mkdocs
-
+permissions: write-all
 on:
   push:
     branches:
@@ -10,8 +10,8 @@ jobs:
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4.2.0
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5.0.0
         with:
           python-version: 3.x
       - run: pip install -r docs/requirements.txt

.github/workflows/lint.yml

@@ -6,7 +6,7 @@ jobs:
   editorconfig-checker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: editorconfig-checker
         run: |
           docker run --rm -v ${GITHUB_WORKSPACE}:/check mstruebing/editorconfig-checker

.gitignore

@@ -1,3 +1,4 @@
 site
-venv
-.vscode
+venv*
+.vscode
+__pycache__/

README.md

@@ -1,3 +1,13 @@
 # tp-docs
 
 Wiki for [https://github.com/themepark-dev/theme.park/](https://github.com/themepark-dev/theme.park/)
+
+### Docs Develop setup
+
+```bash
+git clone https://github.com/themepark-dev/tp-docs.git
+python3 -m venv venv
+source venv/bin/activate
+pip install -r docs/requirements.txt
+mkdocs serve
+```

docs/community-themes/catppuccin/index.md

@@ -0,0 +1,15 @@
+Use `catppuccin-<theme>` Cap sensitive. For example `catppuccin-latte`
+
+## Screenshots
+
+### Latte
+![](/community-themes/screenshots/catppuccin-latte.png)
+
+### Frappe
+![](/community-themes/screenshots/catppuccin-frappe.png)
+
+### Mocha
+![](/community-themes/screenshots/catppuccin-mocha.png)
+
+### Macchiato
+![](/community-themes/screenshots/catppuccin-macchiato.png)

docs/community-themes/index.md

@@ -22,24 +22,28 @@ A: Add it like any other theme-option.
 <a href="/community-themes/infinity-stone-themes/space/"><img src="/community-themes/infinity-stone-themes/space_banner_small.png"/></a>
 <a href="/community-themes/infinity-stone-themes/time/"><img src="/community-themes/infinity-stone-themes/time_banner_small.png"/></a>
 
-## [OneDark](/community-themes/onedark/)
+## [Catppuccin](catppuccin/index.md)
+
+<small> By [sgoudham](https://github.com/sgoudham) </small>
+
+## [OneDark](onedark/index.md)
 
 <small> By [Monklite](https://github.com/Monklite) </small>
 
-## [Blackberry Themes](/community-themes/blackberry-themes)
+## [Blackberry Themes](blackberry-themes/index.md)
 
 <small> By [Archmonger](https://github.com/Archmonger/Blackberry-Themes) </small>
 
-## [Pine Shadow](/community-themes/pine-shadow)
+## [Pine Shadow](pine-shadow/index.md)
 
 <small> By [Pinecone](https://github.com/Pinezerka) </small>
 
-## [True Black](/community-themes/trueblack)
+## [True Black](trueblack/index.md)
 
 <small> By [Draper](https://github.com/Drapersniper) </small>
 
-## [Ibracorp](/community-themes/ibracorp)
+## [Ibracorp](ibracorp/index.md)
 
 <small> By [MountainGod]https://github.com/MountainGod2) </small>
 
-## [Hotline-Old](/community-themes/hotline-old/)
+## [Hotline-Old](hotline-old/index.md)

docs/community-themes/infinity-stone-themes/mind.md

@@ -1,3 +1,5 @@
+Use `mind` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/community-themes/infinity-stone-themes/power.md

@@ -1,3 +1,5 @@
+Use `power` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/community-themes/infinity-stone-themes/reality.md

@@ -1,3 +1,5 @@
+Use `reality` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/community-themes/infinity-stone-themes/soul.md

@@ -1,3 +1,5 @@
+Use `soul` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/community-themes/infinity-stone-themes/space.md

@@ -1,3 +1,5 @@
+Use `space` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/community-themes/infinity-stone-themes/time.md

@@ -1,3 +1,5 @@
+Use `time` Cap sensitive
+
 <p align="center">
 
 <img src="/community-themes/infinity-stone-themes/{{ page.title.lower() }}_banner.png"/>

docs/custom/index.md

@@ -8,7 +8,7 @@ You can't use the raw link from Github as Github doesn't pass the mime types. Th
 
 ## Docker
 
-See [docker](/setup#docker) for more information on selfhosting a docker image
+See [docker](../setup#docker) for more information on selfhosting a docker image
 
 ***
 
@@ -61,10 +61,10 @@ Add the theme to your service and load the page.
 If you press `F12` and go to the `Elements` tab and scroll down you should see the variables in the root pseudo-class.
 Try and disable one of them and you'll see what each variable does.
 
-![custom](/site_assets/custom_themes.png)
+![custom](../site_assets/custom_themes.png)
 
 !!! note "Tip"
-    If you want to have persistent changes while testing out color options, you can use the [stylus](/setup/#stylus-method) plugin for testing.
+    If you want to have persistent changes while testing out color options, you can use the [stylus](../setup/#stylus-method) plugin for testing.
     Just add the content from the theme-option file and start changing stuff.
 
 The `--main-bg-color` will "always" be the  background color.
@@ -75,10 +75,10 @@ And the `--modal-bg-color` will "always" be the background for the popup modals.
 
 If you add a gradient from one of the links below, remember to not overwrite the `center center/cover no-repeat fixed` in the variables. Doing so might make the colors look a little wierd on small objects like drop down menus.
 
-![custom](/site_assets/custom_themes.gif)
+![custom](../site_assets/custom_themes.gif)
 
 When you're done add the theme like you normally would.
-[theme.park Setup](/setup)
+[theme.park Setup](../setup)
 
 ***
 

docs/requirements.txt

@@ -5,4 +5,4 @@ mkdocs-macros-plugin>=0.4.18
 mkdocs-awesome-pages-plugin>=2.4.0
 mkdocs-redirects>=1.0.1
 mkdocs-git-revision-date-localized-plugin>=0.7.3
-mkdocs-include-markdown-plugin==4.0.4
+mkdocs-include-markdown-plugin>=4.0.4

docs/setup.md → docs/setup/index.md

@@ -1,15 +1,81 @@
 # Setup
 
+## How the hell do I add a theme to my app?
+
+There are a lot of different ways you can add a theme to an app. Some methods works for all apps and others only work for specific apps. 
+
+The different categories are:
+
+### Subfiltering
+
+  This modifies a webserver response by replacing one specified string by another. This means we can inject a style sheet at the edge and override the CSS that way. This is supported by nginx, caddy and træfik. 
+
+  Read more [here](#subfilter-method)
+
+  This method should always work for all apps.
+
+!!! info
+    Some apps require a special way to inject the css. This is marked with the ⚠️ icon.
+
+!!! note
+    If the theme does not have one of the 3 icons (🐳🔥⚙️), this is the method to use.
+
+### ⚙️ Built in CSS support
+
+  If the app has the cog icon, the app has native support for changing the CSS. Details on how will be different for each app, and should be described in detail on the app page.
+
+### 🐳 Linuxserver Docker Mods
+
+  This is by far the best and simplest way of changing the CSS. Unfortunately not all apps have a linuxserver container so only a handful of apps supports this method. And even if there is a linuxserver container available, it does not mean it supports injecting the CSS.
+
+  For example the `linuxserver/overseerr` image does not support it as there are no HTML files to edit. This is a limitation of how the app is built, and not something I can change. 
+
+  Read more [here](#docker-mods) 
+
+### 🔥 Hotio/S6-Overlay Images (V3)
+
+  Hotio images do not support docker mods like linuxserver does, but we can mount scripts to the container so they run at startup of the container. and inject the css.
+
+  Read more [here](#hotio-containers-s6-overlay-v3-images)
+
+### Stylus Browser Extension
+
+  This uses a browser extension to inject the CSS on the client. This means it will only work for for that specific browser session.
+
+  Read more [here](#stylus-method)
+
+### Blackberry Theme Installer for Organizr
+
+  This provides an easy to use method of using JS to theme your Organizr tabs. This will only work if your Organizr tab is on a subdirectory (does not work with subdomains). These themes will only be applied when viewed within Organizr.
+
+  Read more [here](#blackberry-theme-installer-method) 
+
+## Selfhosting
+
+  You can selfhost all the CSS files instead of loading them from `theme-park.dev`. 
+
+  Read more [here](#selfhosting)
+
+## Manual download
+
+  Click [here](#manually-download) if you want to manually download the css files used in this project.
+
+## More theme options
+
+  Community themes are theme options that have been added by community members. 
+
+  Check them out [here!](/community-themes/)
+
 ## Methods
 
 <ul>
-    <li><a href="#docker-mods"><img src="/site_assets/lsio.png"> Docker Mods for linuxserver.io images</a><small> Adds the theme locally</small></li>
-        <ul><li><a href="#hotio-containers-s6-overlay-v3-images"><img src="/site_assets/hotio.png"> Hotio containers / S6-Overlay images (V3)</a></li></ul>
+    <li><a href="#docker-mods"><img src="../site_assets/lsio.png"> Docker Mods for linuxserver.io images</a><small> Adds the theme locally</small></li>
+        <ul><li><a href="#hotio-containers-s6-overlay-v3-images"><img src="../site_assets/hotio.png"> Hotio containers / S6-Overlay images (V3)</a></li></ul>
     <li><a href="#selfhosting">Selfhost Method</a><small> Selfhost the files</small></li>
       <ul>  
         <li><a href="#docker">🐋 Docker image</a><small> Selfhost the the files using our docker image</small></li>
         <ul><li><a href="#rootless-docker-image">Rootless option</a><small> An optional rootless docker image</small></li></ul>
-        <li><a href="#swag-docker-mod"><img src="/site_assets/lsio.png"> SWAG Docker Mod</a><small> Selfhost the files using our lsio docker mod for SWAG</small></li>
+        <li><a href="#swag-docker-mod"><img src="../site_assets/lsio.png"> SWAG Docker Mod</a><small> Selfhost the files using our lsio docker mod for SWAG</small></li>
       </ul>
     <li><a href="#subfilter-method">Subfilter Method</a><small> Injects the theme through a proxy</small></li>
     <ul>
@@ -28,12 +94,13 @@
     <li><a href="#develop">Develop</a></li>
     <li><a href="/community-themes/">Community Themes</a></li>
     <li><a href="/custom/#custom-github-setup">Custom Github Setup</a></li>
+    <li><a href="#manually-download">Manual Download</a></li>
 </ul>
 
 ***
 {% set themes = config.extra.themes %}
 {% set cthemes = config.extra.community_themes %}
-All apps have {{ themes|length }} official [themes](/theme-options/organizr/) and {{ cthemes|length }} [community-themes](/community-themes) to choose from.
+All apps have {{ themes|length }} official [themes](theme-options/index.md) and {{ cthemes|length }} [community-themes](community-themes/index.md) to choose from.
 
 `https://theme-park.dev/css/base/<APP_NAME>/<THEME_NAME>.css`
 
@@ -71,7 +138,7 @@ Example: `https://theme-park.dev/css/base/sonarr/dark.css`
 For [linuxserver.io](https://blog.linuxserver.io/2019/09/14/customizing-our-containers) containers to inject theme.park stylesheets.
 
 !!! warning
-    Not all apps support this installation method. See the list to the left on the [themes](/themes/sonarr) overview. Look for the 🐳 icon.
+    Not all apps support this installation method. See the list to the left on the [themes](themes/sonarr.md) overview. Look for the 🐳 icon.
 
 [https://github.com/themepark-dev/theme.park/tree/master/docker-mods](https://github.com/themepark-dev/theme.park/tree/master/docker-mods)
 
@@ -89,16 +156,16 @@ These are the **default** values for all envs. So if you want to use the `organi
 | -------------------- | ------------- | ----------- |
 | `DOCKER_MODS` | `ghcr.io/themepark-dev/theme.park:<app>` | Replace <app\> |
 | `TP_DOMAIN` | `theme-park.dev` | `Optional` Defaults to the example. If you selfhost and use subfolder, you must escape the forward slash. `domain.com\/themepark` |
-| `TP_THEME` | `organizr` | `Optional` The [theme-option](/theme-options) you want to use. Defaults to the example. |
-| `TP_COMMUNITY_THEME` | `true` | `Optional` Set to true if you are using a [community theme option](/community-themes/) |
-| `TP_ADDON` | `radarr-4k-logo` | `Optional` Multiple addons can be added using  the pipe `|` symbol as a separator. Ex: `radarr-4k-logo|radarr-darker` See addon [wiki](/themes/addons/) for all addons |
+| `TP_THEME` | `organizr` | `Optional` The [theme-option](../theme-options/index.md) you want to use. Defaults to the example. |
+| `TP_COMMUNITY_THEME` | `true` | `Optional` Set to true if you are using a [community theme option](../community-themes/index.md) |
+| `TP_ADDON` | `radarr-4k-logo` | `Optional` Multiple addons can be added using  the pipe `|` symbol as a separator. Ex: `radarr-4k-logo|radarr-darker` See addon [wiki](../themes/addons/index.md) for all addons |
 | `TP_SCHEME` | `https` | `Optional` Defaults to example. |
-| `TP_HOTIO` | `true` | `Optional` See [Hotio Containers](#hotio-containers)(Setup#-hotio-containers) |
+| `TP_HOTIO` | `true` | `Optional` See [Hotio Containers](#hotio-containers-s6-overlay-v3-images) |
 | `TP_DISABLE_THEME` | `true` | `Optional` Only used on some mods (Qbt) |
 
 ***
 
-#### ![lsio](/site_assets/lsio.png) LSIO Example
+#### ![lsio](../site_assets/lsio.png) LSIO Example
 
 ```yaml
 version: "2.1"
@@ -135,7 +202,7 @@ docker run -d \
 
 ***
 
-### ![hotio](/site_assets/hotio.png) Hotio containers / S6-Overlay (V3) images
+### ![hotio](../site_assets/hotio.png) Hotio containers / S6-Overlay (V3) images
 
 !!! warning
     The `DOCKER_MODS` variable does not work on Hotio images / S6-Overlay(V3) images (Except LSIO images)!
@@ -160,7 +227,7 @@ Download and mount your script with the volume `/your/docker/host/98-themepark:/
 
 This script will download all mods/scripts into the path you choose.
 
-Defaults to `/tmp/theme-park-mods` is no path argument is passed.
+Defaults to `/tmp/theme-park-mods` if no path argument is passed.
 
 See script contents here: https://github.com/themepark-dev/theme.park/blob/master/fetch.sh
 
@@ -605,7 +672,7 @@ sub_filter
 sub_filter_once on;
 ```
 
-![text](site_assets/setup/npm.png)
+![text](../site_assets/setup/npm.png)
 
 ***
 
@@ -678,6 +745,8 @@ proxy /tautulli 127.0.0.1:8181 {
 
 ### Caddy v2
 
+!!! warning
+  This plugin will not work if the software uses websockets. See (https://github.com/sjtug/caddy2-filter/issues/10)
 >
 !!! info
     Thank you [jef](https://github.com/jef) for the write up!
@@ -826,7 +895,7 @@ Add the following to your static `traefik` config.
 ```yaml
 experimental:
   plugins:
-    theme-park:
+    themepark:
       modulename: "github.com/packruler/traefik-themepark"
       version: "v1.2.0"
 ```
@@ -889,7 +958,7 @@ Example:
 @import "https://theme-park.dev/css/base/sonarr/nord.css";
 ```
 
-![example](site_assets/setup/stylus.png)
+![example](../site_assets/setup/stylus.png)
 
 Link to Chrome extention:
 
@@ -929,3 +998,16 @@ sub_filter_once on;
 ```
 
 Docker mods: `-e TP_DOMAIN=develop.theme-park.dev`
+
+
+## Manually Download
+
+If you want to manually download the css files used in this project, you can find all css files in the [`/css`](https://github.com/themepark-dev/theme.park/tree/master/css) folder on github.
+
+The base files can be found in the [`/base`](https://github.com/themepark-dev/theme.park/tree/master/css/base) folder, and the theme option files (that contains the css to actually give it some color) can be found in the [`/theme-options`](https://github.com/themepark-dev/theme.park/tree/master/css/theme-options) folder.
+
+
+The [`/defaults`](https://github.com/themepark-dev/theme.park/tree/master/css/defaults) contains a couple of extra files that you will also need depending on the base css file you are downloading. (See the imports in each base file)
+
+!!! Tip
+    I reccomend to switch to the [`live`](https://github.com/themepark-dev/theme.park/tree/live/css) or [`develop`](https://github.com/themepark-dev/theme.park/tree/develop/css) branch on github when downloading the base files as those base files have the contents of the the imports directly in them, so you don't need the `placeholders.css` or `transparent.css` css files etc.