Add & update some docs

Isaaker · Jul 4, 2024 · 490fc17 · 490fc17
1 parent f9de580
commit 490fc17
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 32 deletions.
diff --git a/Lists/WHITELIST.md b/Lists/WHITELIST.md
@@ -2,11 +2,11 @@
 
 Created by: Isaaker
 
-Revised: 16/5/23
+Revised: 4/7/23
 
 Version: WHITELIST
 
-Number of domains: 4
+Number of domains: 5
 
 Read more: https://github.com/Isaaker/Spotify-AdsList
 

diff --git a/docs/docs_installation.md b/docs/docs_installation.md
@@ -17,7 +17,8 @@ The currently supported adblockers are:
 - [Adguard](https://adguard.com/es/welcome.html)
 - [uBlock Origin](https://ublockorigin.com)
 
-**Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.**
+!!! tip:
+    Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.
 
 ## 2. Find the right list format
 
@@ -33,7 +34,8 @@ Here is a table to find the right format for your adblcoker:
 | uBlock Origin | Adguard |
 | Standard (with hosts file or adblockers that supports 0.0.0.0 entry) | Standard |
 
-**Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.**
+!!! tip:
+    Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.
 
 ## 3. (Optional) Setup your adblocker & Spotify
 
@@ -64,12 +66,22 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil
 
 # Standard adblockers
 
-| Adblocker | Raw URL | How to add this? |
-| -- | -- | -- |
-| Standard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt | Not applicable, unless you want to use the hosts file. In that case, [read this](https://nordvpn.com/es/blog/use-hosts-file-block-ads-malware/) |
-| Pi-hole | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/pi-hole.txt | Not official documentation for this, go to the Web UI, in the left bar click on "Adlists", enter the raw url and click "Add" |
-| Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | There is not much official documentation, perhaps [this will help](https://dnsmasq.org/docs/dnsmasq-man.html) |
-| Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | [Read this](https://adguard.com/kb/) |
+| Adblocker | Raw URL
+| -- | -- |
+| Standard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt |
+| Pi-hole | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/pi-hole.txt |
+| Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt |
+| Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt |
+
+!!! question inline end "How can I do this?":
+    You can find more help about how to add this on this links:
+
+    | Adblocker | Link |
+    |--|--|
+    | Standard | Not applicable, unless you want to use the hosts file. In that case, [read this](https://nordvpn.com/es/blog/use-hosts-file-block-ads-malware/) |
+    | Pi-hole | Not official documentation for this, go to the Web UI, in the left bar click on "Adlists", enter the raw url and click "Add" |
+    | Dnsmasq | There is not much official documentation, perhaps [this will help](https://dnsmasq.org/docs/dnsmasq-man.html) |
+    | Adguard | [Read this](https://adguard.com/kb/) |
 
 ### Browser adblockers
 
@@ -80,28 +92,26 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil
 | Firefox | moz-extension://c396fed9-d8f8-4a6c-95a0-80773fa36d8a/asset-viewer.html?url=https%3A%2F%2Fraw.luolix.top%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 |
 | Chrome / Chromium | chrome-extension://cjpalhdlnbpafiamejdnhcphjbkeiagm/asset-viewer.html?url=https%3A%2F%2Fraw.luolix.top%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 |
 
-[You can also make this manually with the adguard raw URL](https://github.com/gorhill/uBlock/wiki/Dashboard:-Filter-lists#3rd-party-filter-lists)
+!!! tip:
+    [You can also make this manually with the adguard raw URL](https://github.com/gorhill/uBlock/wiki/Dashboard:-Filter-lists#3rd-party-filter-lists)
 
 ## 5. Add Spotify Ads List whitelist to your adblocker
 
-A whitelist is a list that lets your adblocker know which domains should not be blocked. Although usually these domains are not added to the list directly, many times some domains that are on the list (blocked) redirect legitimate requests to these domains (not blocked) via a CNAME and these requests are blocked before being redirected because it is a blocked domain. Therefore, the list will help you to ensure that legitimate requests can continue their course correctly.
-
-To add the whitelist to your adblocker, you have to enter this domains manually in the whitelist area:
+To add the whitelist to your adblocker, you have to enter the whitelist domains manually in the whitelist area. You can found the whitelist on this [link](./docs_whitelist.md)
 
-- login5.spotify.com
-- spclient.wg.spotify.com
-- open.spotify.com
-- api-partner.spotify.com
+!!! question inline end "How can I do this?":
+    You can find more help about how to add this on this links:
 
-You can find more help about how to add this on this links:
+    | Adblocker | Link |
+    |--|--|
+    | Standard | This is not possible in the hosts file, for other methods please consult your adblocker documentation |
+    | Pi-hole | [Read this](https://discourse.pi-hole.net/t/how-do-i-whitelist-or-blacklist-a-domain/244), you can also make this form the Web UI > Domains |
+    | Dnsmasq | Not docs of this available |
+    | Adguard | [Read this](https://github.com/AdguardTeam/AdGuardHome/discussions/3771) |
+    | uBlock Origin | [Read this](https://github.com/gorhill/uBlock/wiki/How-to-whitelist-a-web-site/745c6f01e1f88db8184bb27f48bbdd8a21b48a90) |
 
-| Adblocker | Link |
-|--|--|
-| Standard | This is not possible in the hosts file, for other methods please consult your adblocker documentation |
-| Pi-hole | [Read this](https://discourse.pi-hole.net/t/how-do-i-whitelist-or-blacklist-a-domain/244), you can also make this form the Web UI > Domains |
-| Dnsmasq | Not docs of this available |
-| Adguard | [Read this](https://github.com/AdguardTeam/AdGuardHome/discussions/3771) |
-| uBlock Origin | [Read this](https://github.com/gorhill/uBlock/wiki/How-to-whitelist-a-web-site/745c6f01e1f88db8184bb27f48bbdd8a21b48a90) |
+!!! info:
+    A whitelist is a list that lets your adblocker know which domains should not be blocked. Although usually these domains are not added to the list directly, many times some domains that are on the list (blocked) redirect legitimate requests to these domains (not blocked) via a CNAME and these requests are blocked before being redirected because it is a blocked domain. Therefore, the list will help you to ensure that legitimate requests can continue their course correctly.
 
 ## 6. What can I do now?
 

diff --git a/docs/docs_testing.md b/docs/docs_testing.md
@@ -15,4 +15,5 @@ Here you can find all the tests made, their date and more details.
 | App | Windows Laptop | Windows 11 (10.0.22631) | - | 26/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | pihole | @MW-SAND |
 | Web App | Windows Computer | Windows (22H2 19045.4170) | Chrome (126.0.6478.127 (64 bits)) | 29/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | ublock origin | @AlkBek |
 
-**If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D)**
+!!! info:
+    If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D)
diff --git a/docs/docs_whitelist.md b/docs/docs_whitelist.md
@@ -0,0 +1,34 @@
+# Spotify Ads Whitelist
+
+!!! info:
+    Created by: Isaaker
+
+    Revised: 4/7/23
+
+    Version: WHITELIST
+
+    Number of domains: 5
+
+
+!!! warning:
+    This list is not formatted in any special way and therefore cannot be downloaded and used as an input file, please add the domains manually.
+
+## Detailed list
+
+| Domain | Explanation | What happens when it is blocked? |
+| -- | -- | -- |
+| login5.spotify.com | Spotify login domain | Unable to log in to Spotify no audio is played and many screens cannot be accessed |
+| spclient.wg.spotify.com | Spotify domain providing music and controlling it | The player does not work, it is impossible to control the audio playback and this causes it to skip songs continuously and without stopping |
+| open.spotify.com | In principle, I have not observed any adverse effect on the applications when blocking this domain, however, blocking it makes it impossible to access the spotify web platform | Unable to access the spotify web player |
+| api-partner.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images |
+| partners.wg.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images |
+| api.spotify.com | Spotify main API |
+
+## Plain List
+
+- login5.spotify.com
+- spclient.wg.spotify.com
+- open.spotify.com
+- api-partner.spotify.com
+- partners.wg.spotify.com
+- api.spotify.com
diff --git a/docs/docs_index.md → docs/index.md b/docs/docs_index.md → docs/index.md
@@ -2,4 +2,5 @@
 
 ![Spotify Ads List Logo](./images/spotify_ads_list_logo.png)
 
-**🔼 Use the menu at the top to navigate 🔼**
+!!! tip:
+    🔼 Use the menu at the top to navigate 🔼
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,8 @@
-site_name: Spotify-AdsList
+site_name: Spotify Ads List
 site_url: https://spotify.piscinadeentropia.es
 site_description: No more spotify ADS
 copyright: License <a href="https://github.com/Isaaker/Spotify-AdsList/blob/main/LICENSE.txt">Creative Commons Attribution-ShareAlike 4.0 International Public License</a> | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited
+repo_url: https://github.com/Isaaker/Spotify-AdsList/
 
 theme:
     name: material
@@ -11,12 +12,13 @@ theme:
     font:
         text: Ubuntu 
         code: IBM Plex Mono 
+    icon:
+      repo: fontawesome/brands/github
     features:
       - navigation.tabs
       - navigation.tabs.sticky
       - navigation.sections
       - navigation.top
-      - navigation.footer
       - search.suggest
     palette:
       - primary: green
@@ -44,7 +46,7 @@ plugins:
       hooks:
         on_config: "hooks.on_config:deploy_hooks"
 nav:
-    - Home: docs_index.md
+    - Home: index.md
     - Installation: docs_installation.md
     - Versions:
       - "Standard": "docs_standard.md"
@@ -63,4 +65,7 @@ nav:
       - "License": docs_license.md
       - "Contributing.md": docs_contributing.md
     - Report Bug: https://github.com/Isaaker/Spotify-AdsList/issues
-
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/Isaaker/Spotify-AdsList/