Merge branch 'main' into docs/instance-based

catppuccin · Oct 8, 2023 · 346140b · 346140b
2 parents efbea80 + ce44450
commit 346140b
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ giving it a unique and appealing aesthetic in line with Catppuccin's color palet
 
 To install these userstyles:
 
-1. Install [Stylus](https://github.com/openstyles/stylus)
+1. Install [Stylus](https://github.com/openstyles/stylus).
    - [Firefox](https://addons.mozilla.org/en-GB/firefox/addon/styl-us/)/[Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne)
      extension.
 2. Enable CSP Patching from `Stylus Settings` > `Advanced`.
@@ -55,10 +55,10 @@ To install these userstyles:
 
 ## 👐 Contributing
 
-> **Note** <br>
-> If you would like to submit a userstyle or learn how to port Catppuccin to a website, please refer to the [userstyle-creation.md](docs/userstyle-creation.md).
+> [!NOTE]
+> If you would like to submit a userstyle or learn how to port Catppuccin to a website, please refer to [userstyle-creation.md](docs/userstyle-creation.md).
 
-See [CONTRIBUTING.md](docs/CONTRIBUTING.md)
+See [CONTRIBUTING.md](docs/CONTRIBUTING.md).
 
 &nbsp;
 

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -12,7 +12,7 @@ request.
 
 It is important to note that there are **two types of PRs** for this repository:
 
-1. **New Userstyles:** Please see [userstyle-creation.md](userstyle-creation.md)
+1. **New Userstyles:** Please see [userstyle-creation.md](userstyle-creation.md).
 2. **Other improvements:** These should follow the recommendations below, to help
    improve the chances of a merged PR.
 

diff --git a/docs/userstyle-creation.md b/docs/userstyle-creation.md
@@ -3,7 +3,7 @@
 </p>
 
 <p align="center">
-	Guidelines for requesting and creating userstyles
+	Guidelines for requesting and creating userstyles.
 </p>
 
 &nbsp;

diff --git a/src/userstyles.yml b/src/userstyles.yml
@@ -105,7 +105,7 @@ userstyles:
     readme:
       app-link: ["https://anilist.co", "https://anichart.net"]
       usage: |+
-        > **Note** <br>
+        > [!NOTE]
         > This theme applies to [AniChart](https://anichart.net/) as well, which is an extension of AniList.
       current-maintainers: [*anubisnekhet]
   boringproxy:
@@ -121,7 +121,7 @@ userstyles:
     color: peach
     readme:
       app-link: "https://search.brave.com"
-      usage: "Set theme to dark or light in Brave Search settings, the automatic setting will not work"
+      usage: "Make sure to set the theme to either dark or light in Brave Search settings, as the automatic setting will not work."
       current-maintainers: [*ndsboy]
   bstats:
     name: bStats
@@ -169,7 +169,7 @@ userstyles:
       app-link: "https://codeberg.org"
       faq:
         - question: "How do I change the accent color?"
-          answer: "Changing `--color-primary` to any other color should change the accent color in most places"
+          answer: "Changing `--color-primary` to any other color should change the accent color in most places."
       current-maintainers: [*justtobbi]
   crowdin:
     name: Crowdin
@@ -275,16 +275,20 @@ userstyles:
     readme:
       app-link: "https://github.com/mastodon/mastodon"
       usage: |+
-        Add urls to `@-moz-document domain("url")` with url being the chosen server
+        This userstyle is applied by default on a few common Mastodon server URLs, listed at the top:
+        ```css
+        @-moz-document domain("mastodon.social"), domain("mstdn.social"), domain("fosstodon.org"), domain("piaille.fr"), domain("tech.lgbt") {
+        ```
+        If you don't see your Mastodon server URL, feel free to add it to the list with the `domain("<URL>")` syntax.
         > [!WARNING]
         > On update your custom `@-moz-document domain("url")` will be removed so will have to re applied upon update. 
         > Therfore we strongly encorage users to contribute to the project with their instances.
       faq:
         - question: "**The theme does not look the same as the preview?**"
-          answer: "Your Mastodon instance may be using its own custom CSS, which is changing the look of the theme"
-        - question: "**Theme is not working?**"
+          answer: "Your Mastodon instance may be using its own custom CSS, which is changing the look of the theme."
+        - question: "**The theme is not working?**"
           answer: |
-            One solution might be changing the theme from the `preferences > application > theme` to light or dark.
+            One solution might be changing the theme to either light or dark via **Preferences** > **Appearance** > **Site theme**.
       current-maintainers: [*isabelroses]
       past-maintainers: [*andreasgrafen]
   modrinth:
@@ -316,7 +320,7 @@ userstyles:
     readme:
       app-link: "https://paste.rs"
       current-maintainers: [*stonks3141]
-  planet-minecraft: 
+  planet-minecraft:
     name: Planet Minecraft
     category: game
     readme:
@@ -329,7 +333,9 @@ userstyles:
     color: lavender
     readme:
       app-link: "https://proton.me/"
-      usage: "Open Proton Mail and click the settings in the top right, then set the base theme to `Snow` if you are using the Latte flavor, otherwise set it to `Carbon`"
+      usage: |+
+        > [!NOTE]
+        > Set Proton Mail's built-in theme to 'Snow' if you're using Latte or 'Carbon' if you're using the others.
       current-maintainers: [*soya-daizu]
   quizlet:
     name: Quizlet
@@ -384,8 +390,8 @@ userstyles:
     readme:
       app-link: "https://syncthing.net"
       usage: |+
-        > **Note** <br>
-        > This theme is designed to be used with the default WebGUI and default theme provided by Syncthing. This doesn't theme syncthing.net
+        > [!NOTE]
+        > This theme is designed to be used with the default WebGUI and default theme provided by Syncthing. This does not theme syncthing.net.
       current-maintainers: [*BlankParticle]
   tutanota:
     name: Tutanota
@@ -394,7 +400,7 @@ userstyles:
     readme:
       app-link: "https://tutanota.com/"
       usage: |+
-        > **Note** <br>
+        > [!NOTE]
         > Set Tutanota's built-in theme to either **light** if you're using Latte or **dark** if you're using the others.
       current-maintainers: [*ryanccn]
   twitch:
@@ -405,7 +411,7 @@ userstyles:
     readme:
       app-link: "https://twitch.tv"
       usage: |+
-        > **Note** <br>
+        > [!NOTE]
         > Set Twitch's built-in theme to either **light** if you're using Latte or **dark** if you're using the others.
       current-maintainers: [*gitmuslim, *isabelroses]
   vercel:
@@ -435,7 +441,7 @@ userstyles:
       app-link: "https://youtube.com"
       faq:
         - question: "**What does the 'Enable for black bars' option mean?**"
-          answer: "It is there in-case you have an OLED display. If you have one, you might want to enable this."
+          answer: "It's available in case you have an OLED display. If you have one, you might want to enable this."
       current-maintainers: [*isabelroses]
       past-maintainers: [*elkrien]
 # yaml-language-server: $schema=https://raw.githubusercontent.com/catppuccin/userstyles/main/src/userstyles.schema.json
diff --git a/styles/anilist/README.md b/styles/anilist/README.md
@@ -37,7 +37,7 @@
 </details>
 
 ## Usage  
-> **Note** <br>
+> [!NOTE]
 > This theme applies to [AniChart](https://anichart.net/) as well, which is an extension of AniList.
 
 

diff --git a/styles/brave-search/README.md b/styles/brave-search/README.md
@@ -37,7 +37,7 @@
 </details>
 
 ## Usage  
-Set theme to dark or light in Brave Search settings, the automatic setting will not work
+Make sure to set the theme to either dark or light in Brave Search settings, as the automatic setting will not work.
 
 
 

diff --git a/styles/codeberg/README.md b/styles/codeberg/README.md
@@ -40,7 +40,7 @@
 
 ## 🙋 FAQ
 - Q: How do I change the accent color?  
-	A: Changing `--color-primary` to any other color should change the accent color in most places
+	A: Changing `--color-primary` to any other color should change the accent color in most places.
 
 ## 💝 Current Maintainer(s)
 - [justTOBBI](https://github.com/justTOBBI)

diff --git a/styles/mastodon/README.md b/styles/mastodon/README.md
@@ -37,14 +37,18 @@
 </details>
 
 ## Usage  
-Add urls to `@-moz-document domain("url")` with url being the chosen server
+This userstyle is applied by default on a few common Mastodon server URLs, listed at the top:
+```css
+@-moz-document domain("mastodon.social"), domain("mstdn.social"), domain("fosstodon.org"), domain("piaille.fr"), domain("tech.lgbt") {
+```
+If you don't see your Mastodon server URL, feel free to add it to the list with the `domain("<URL>")` syntax.
 
 
 ## 🙋 FAQ
 - Q: **The theme does not look the same as the preview?**  
-	A: Your Mastodon instance may be using its own custom CSS, which is changing the look of the theme
-- Q: **Theme is not working?**  
-	A: One solution might be changing the theme from the `preferences > application > theme` to light or dark.
+	A: Your Mastodon instance may be using its own custom CSS, which is changing the look of the theme.
+- Q: **The theme is not working?**  
+	A: One solution might be changing the theme to either light or dark via **Preferences** > **Appearance** > **Site theme**.
 
 
 ## 💝 Current Maintainer(s)

diff --git a/styles/mastodon/catppuccin.user.css b/styles/mastodon/catppuccin.user.css
@@ -13,11 +13,11 @@
 @var select darkFlavor "Dark Flavor" ["latte:Latte", "frappe:Frappé", "macchiato:Macchiato", "mocha:Mocha*"]
 @var select accentColor "Accent" ["rosewater:Rosewater", "flamingo:Flamingo", "pink:Pink", "mauve:Mauve", "red:Red", "maroon:Maroon", "peach:Peach", "yellow:Yellow", "green:Green", "teal:Teal", "blue:Blue", "sapphire:Sapphire*", "sky:Sky", "lavender:Lavender", "subtext0:Gray"]
 ==/UserStyle== */
-@-moz-document domain("mstdn.social"),
+@-moz-document domain("mastodon.social"),
+domain("mstdn.social"),
 domain("fosstodon.org"),
-domain("tech.lgbt"),
-domain("mastodon.social"),
-domain("piaille.fr") {
+domain("piaille.fr"),
+domain("tech.lgbt") {
   .theme-mastodon-light,
   .skin-mastodon-light {
     #mastodon(@lightFlavor, @accentColor);

diff --git a/styles/proton/README.md b/styles/proton/README.md
@@ -37,7 +37,9 @@
 </details>
 
 ## Usage  
-Open Proton Mail and click the settings in the top right, then set the base theme to `Snow` if you are using the Latte flavor, otherwise set it to `Carbon`
+> [!NOTE]
+> Set Proton Mail's built-in theme to 'Snow' if you're using Latte or 'Carbon' if you're using the others.
+
 
 
 

diff --git a/styles/syncthing/README.md b/styles/syncthing/README.md
@@ -37,8 +37,8 @@
 </details>
 
 ## Usage  
-> **Note** <br>
-> This theme is designed to be used with the default WebGUI and default theme provided by Syncthing. This doesn't theme syncthing.net
+> [!NOTE]
+> This theme is designed to be used with the default WebGUI and default theme provided by Syncthing. This does not theme syncthing.net.
 
 
 

diff --git a/styles/tutanota/README.md b/styles/tutanota/README.md
@@ -37,7 +37,7 @@
 </details>
 
 ## Usage  
-> **Note** <br>
+> [!NOTE]
 > Set Tutanota's built-in theme to either **light** if you're using Latte or **dark** if you're using the others.
 
 

diff --git a/styles/twitch/README.md b/styles/twitch/README.md
@@ -37,7 +37,7 @@
 </details>
 
 ## Usage  
-> **Note** <br>
+> [!NOTE]
 > Set Twitch's built-in theme to either **light** if you're using Latte or **dark** if you're using the others.
 
 

diff --git a/styles/youtube/README.md b/styles/youtube/README.md
@@ -40,7 +40,7 @@
 
 ## 🙋 FAQ
 - Q: **What does the 'Enable for black bars' option mean?**  
-	A: It is there in-case you have an OLED display. If you have one, you might want to enable this.
+	A: It's available in case you have an OLED display. If you have one, you might want to enable this.
 
 ## 💝 Current Maintainer(s)
 - [Isabel](https://github.com/isabelroses)