From 3f7078be5478e773cd07f8e295e1f3a1d64a5b65 Mon Sep 17 00:00:00 2001 From: lscambo13 Date: Fri, 2 May 2025 09:40:46 -0700 Subject: [PATCH] New: Updated the documentation --- README.md | 54 +++++++++++++++++----------- Add-Ons.md => custom-media-covers.md | 0 2 files changed, 34 insertions(+), 20 deletions(-) rename Add-Ons.md => custom-media-covers.md (100%) diff --git a/README.md b/README.md index bcfa17d..90a4868 100644 --- a/README.md +++ b/README.md @@ -70,8 +70,38 @@ https://github.com/user-attachments/assets/7a492f89-9c82-4038-a07a-a9a59e4f8eef
### 🧩 How to customise this theme? -- Documentation yet to be added. Help needed. -- [Experimental add-ons](https://github.com/lscambo13/ElegantFin/blob/main/Add-Ons.md) + +
+ 1. Custom media covers for user media libraries + +- [Preview](https://private-user-images.githubusercontent.com/32175188/438879202-343b8aae-fbae-4ad6-bff7-c1baf5573b1a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDYyMDMyNTEsIm5iZiI6MTc0NjIwMjk1MSwicGF0aCI6Ii8zMjE3NTE4OC80Mzg4NzkyMDItMzQzYjhhYWUtZmJhZS00YWQ2LWJmZjctYzFiYWY1NTczYjFhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTA1MDIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwNTAyVDE2MjIzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWI3MjE3YjNjOGU2ZDU2YTdmMTg0MzA5ZGYyMGY0N2UxZmU4OGRlNmM5MjkzZTVhZmU5NTVlYmNlOTE5OTE4ZGMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.kQTa5XFb2lEHxPJeCG8eOnAqrWLdoSZXWSxF_R0NscQ) +- Read more about this experimental add-on [here](https://github.com/lscambo13/ElegantFin/blob/main/custom-media-covers.md) + +
+ +
+ 2. Custom background image for the login page + +- [Preview](https://user-images.githubusercontent.com/16425113/129554147-6ac7ba51-43e7-4c8e-ba77-e646a3ef6b12.jpg) +- To enable the background wallpaper on the login screen, first tick the 'Enable the splash screen' option in your Jellyfin Dashboard below the Custom CSS Box. +- Second, copy and paste the following code at the end in Custom CSS box but don't save yet. + ``` + :root{ + --loginPageBgUrl: url("/Branding/Splashscreen?format=webp&foregroundLayer=1&quality=33&width=3840&height=2160&blur=2"); + } + ``` +- Third, replace `` with your Jellyfin server address, for example, `http://192.168.0.1:8097`. +- Don't forget the correct http or https in your domain. +- You can also modify the parameters, for example blur size or the resolution, according to your liking. +- Once done, save and refresh your apps and webpages. +
+ +
+ 3. Bring back the home button in the app header + +- Read more about steps [here](https://github.com/lscambo13/ElegantFin/issues/51) + +

@@ -120,23 +150,7 @@ https://github.com/user-attachments/assets/7a492f89-9c82-4038-a07a-a9a59e4f8eef
- 5️⃣ - How to customize the login screen? (Just for the development version for now) - -- To enable the background wallpaper [like this](https://user-images.githubusercontent.com/16425113/129554147-6ac7ba51-43e7-4c8e-ba77-e646a3ef6b12.jpg) on the login screen, first tick the 'Enable the splash screen' option in your Jellyfin Dashboard below the Custom CSS Box. -- Second, copy and paste the following code at the end in Custom CSS box but don't save yet. - ``` - :root{ - --loginPageBgUrl: url("/Branding/Splashscreen?format=webp&foregroundLayer=1&quality=33&width=3840&height=2160&blur=2"); - } - ``` -- Third, replace `` with your Jellyfin server address, for example, `http://192.168.0.1:8097`. -- Don't forget the correct http or https in your domain. -- You can also modify the parameters, for example blur size or the resolution, according to your liking. -- Once done, save and refresh your apps and webpages. -
- -
- 6️⃣ - How do I report bugs/issues? + 5️⃣ - How do I report bugs/issues? - First check [here](https://github.com/lscambo13/ElegantFin/issues?q=) whether a similar issue has been reported already. If it exists, upvote and comment there to let me know. - Alternatively, create a new issue [here](https://github.com/lscambo13/ElegantFin/issues/new/choose). @@ -144,7 +158,7 @@ https://github.com/user-attachments/assets/7a492f89-9c82-4038-a07a-a9a59e4f8eef
- 7️⃣ - When can I expect another update? + 6️⃣ - When can I expect another update? - 🤷
diff --git a/Add-Ons.md b/custom-media-covers.md similarity index 100% rename from Add-Ons.md rename to custom-media-covers.md