Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 2.48 KB

USAGE.md

File metadata and controls

33 lines (22 loc) · 2.48 KB
Raw

Usage

For both of the below installation methods, you will need the Stylus browser extension installed. Install Stylus for Chrome or Firefox. If you use Chrome, make sure to enable "Allow access to file URLs" in the Chrome extension settings for Stylus (visit chrome://extensions/?id=clngdbkpkpeebahjckkjfobafhncgmne).

Tip

If you use Dark Reader, make sure to disable the extension on websites with Catppuccin userstyles installed to avoid conflicts.

All Userstyles

  1. Download the compiled Stylus export file, containing our recommended Stylus settings and all userstyles preloaded: import.json (download).
    • Alternatively, if you want to further customize the import.json file - such as setting it so that all userstyles have the accent color peach, or the dark flavor is always frappe - you can download a customized Stylus export file from @uncenter's "Catppuccin Userstyles Customizer" instead.
  2. Open the Stylus "manage" page.
  3. On the sidebar panel, click the Import button in the Backup section, and select the downloaded file from step 1.
  4. Enjoy!

Individual Userstyles

  1. Enable CSP Patching from Stylus's Settings > Advanced.
  2. Install userstyles from the list below by clicking the Stylus Install badge in each README.
  3. Enjoy!

Configuration

All userstyles come with three default configuration options; the light flavor, the dark flavor, and the accent color. Some userstyles may offer additional site-specific options as well.

Decentralized/self-hosted applications

For decentralized or self-hosted applications, you can apply a theme to one or multiple instances across updates by following the instructions below.

  1. Open the Stylus "Manage" page.
  2. Click on the userstyle's name in the list.
  3. Click on Style settings in the left panel.
  4. Enter the URL patterns for your instance(s) in the text box labeled Custom included sites. For example, to apply a userstyle to example.org, you would add a line with https://example.org/* to the textbox. The trailing asterisk applies it to all pages on the domain - without it, only the root page is themed.