diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 2e47bb64..15d8aa4b 100644 --- a/.github/workflows/deploy.yml +++ b/.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 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 9abd7265..d85c53ec 100644 --- a/.github/workflows/lint.yml +++ b/.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 diff --git a/.gitignore b/.gitignore index 9631761c..25da9d5f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ site -venv -.vscode \ No newline at end of file +venv* +.vscode +__pycache__/ \ No newline at end of file diff --git a/README.md b/README.md index 2d2b60f9..9ec1fe2e 100644 --- a/README.md +++ b/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 +``` diff --git a/docs/community-themes/catppuccin/index.md b/docs/community-themes/catppuccin/index.md new file mode 100644 index 00000000..c6cf621a --- /dev/null +++ b/docs/community-themes/catppuccin/index.md @@ -0,0 +1,15 @@ +Use `catppuccin-` 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) diff --git a/docs/community-themes/index.md b/docs/community-themes/index.md index 37860c2d..c83b020a 100644 --- a/docs/community-themes/index.md +++ b/docs/community-themes/index.md @@ -22,24 +22,28 @@ A: Add it like any other theme-option. -## [OneDark](/community-themes/onedark/) +## [Catppuccin](catppuccin/index.md) + + By [sgoudham](https://github.com/sgoudham) + +## [OneDark](onedark/index.md) By [Monklite](https://github.com/Monklite) -## [Blackberry Themes](/community-themes/blackberry-themes) +## [Blackberry Themes](blackberry-themes/index.md) By [Archmonger](https://github.com/Archmonger/Blackberry-Themes) -## [Pine Shadow](/community-themes/pine-shadow) +## [Pine Shadow](pine-shadow/index.md) By [Pinecone](https://github.com/Pinezerka) -## [True Black](/community-themes/trueblack) +## [True Black](trueblack/index.md) By [Draper](https://github.com/Drapersniper) -## [Ibracorp](/community-themes/ibracorp) +## [Ibracorp](ibracorp/index.md) By [MountainGod]https://github.com/MountainGod2) -## [Hotline-Old](/community-themes/hotline-old/) +## [Hotline-Old](hotline-old/index.md) diff --git a/docs/community-themes/infinity-stone-themes/mind.md b/docs/community-themes/infinity-stone-themes/mind.md index 5f09febd..e4ea72d2 100644 --- a/docs/community-themes/infinity-stone-themes/mind.md +++ b/docs/community-themes/infinity-stone-themes/mind.md @@ -1,3 +1,5 @@ +Use `mind` Cap sensitive +

diff --git a/docs/community-themes/infinity-stone-themes/power.md b/docs/community-themes/infinity-stone-themes/power.md index 5f09febd..130b40cf 100644 --- a/docs/community-themes/infinity-stone-themes/power.md +++ b/docs/community-themes/infinity-stone-themes/power.md @@ -1,3 +1,5 @@ +Use `power` Cap sensitive +

diff --git a/docs/community-themes/infinity-stone-themes/reality.md b/docs/community-themes/infinity-stone-themes/reality.md index 5f09febd..5d03f98f 100644 --- a/docs/community-themes/infinity-stone-themes/reality.md +++ b/docs/community-themes/infinity-stone-themes/reality.md @@ -1,3 +1,5 @@ +Use `reality` Cap sensitive +

diff --git a/docs/community-themes/infinity-stone-themes/soul.md b/docs/community-themes/infinity-stone-themes/soul.md index 5f09febd..c2c25317 100644 --- a/docs/community-themes/infinity-stone-themes/soul.md +++ b/docs/community-themes/infinity-stone-themes/soul.md @@ -1,3 +1,5 @@ +Use `soul` Cap sensitive +

diff --git a/docs/community-themes/infinity-stone-themes/space.md b/docs/community-themes/infinity-stone-themes/space.md index 5f09febd..b483f25f 100644 --- a/docs/community-themes/infinity-stone-themes/space.md +++ b/docs/community-themes/infinity-stone-themes/space.md @@ -1,3 +1,5 @@ +Use `space` Cap sensitive +

diff --git a/docs/community-themes/infinity-stone-themes/time.md b/docs/community-themes/infinity-stone-themes/time.md index 5f09febd..42e0390c 100644 --- a/docs/community-themes/infinity-stone-themes/time.md +++ b/docs/community-themes/infinity-stone-themes/time.md @@ -1,3 +1,5 @@ +Use `time` Cap sensitive +

diff --git a/docs/community-themes/screenshots/catppuccin-frappe.png b/docs/community-themes/screenshots/catppuccin-frappe.png new file mode 100644 index 00000000..9e097f96 Binary files /dev/null and b/docs/community-themes/screenshots/catppuccin-frappe.png differ diff --git a/docs/community-themes/screenshots/catppuccin-latte.png b/docs/community-themes/screenshots/catppuccin-latte.png new file mode 100644 index 00000000..969877fc Binary files /dev/null and b/docs/community-themes/screenshots/catppuccin-latte.png differ diff --git a/docs/community-themes/screenshots/catppuccin-macchiato.png b/docs/community-themes/screenshots/catppuccin-macchiato.png new file mode 100644 index 00000000..bf09fe14 Binary files /dev/null and b/docs/community-themes/screenshots/catppuccin-macchiato.png differ diff --git a/docs/community-themes/screenshots/catppuccin-mocha.png b/docs/community-themes/screenshots/catppuccin-mocha.png new file mode 100644 index 00000000..7650c7a0 Binary files /dev/null and b/docs/community-themes/screenshots/catppuccin-mocha.png differ diff --git a/docs/custom/index.md b/docs/custom/index.md index afafe50f..b41f81d3 100644 --- a/docs/custom/index.md +++ b/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) *** diff --git a/docs/requirements.txt b/docs/requirements.txt index 8e0f9d9e..0681b722 100644 --- a/docs/requirements.txt +++ b/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 \ No newline at end of file +mkdocs-include-markdown-plugin>=4.0.4 diff --git a/docs/setup.md b/docs/setup/index.md similarity index 83% rename from docs/setup.md rename to docs/setup/index.md index 61aec954..a82c074f 100644 --- a/docs/setup.md +++ b/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