1
0
mirror of https://github.com/nileane/TangerineUI-for-Mastodon synced 2024-11-24 07:06:10 +09:00
A Tangerine redesign for Mastodon's Web UI. 🍊🐘
Go to file
2023-07-20 14:58:16 +02:00
mastodon Improved content warning input 2023-07-20 14:58:16 +02:00
.gitignore Added theme files 2023-07-19 17:43:03 +02:00
LICENSE Update LICENSE 2023-07-13 15:03:44 +02:00
README.md Update README.md : wording 2023-07-19 19:01:02 +02:00
TangerineUI-purple.css Improved content warning input 2023-07-20 14:58:16 +02:00
TangerineUI.css Improved content warning input 2023-07-20 14:58:16 +02:00

Tangerine UI for Mastodon 🍊🐘

A Tangerine redesign for Mastodon's Web UI, using just CSS.
Tangerine UI features a bubblier look, a more compact timeline, round avatars, and a soft color palette.

Variants

  • Tangerine 🍊
    Default variant for Tangerine UI, featuring a soft orange palette.

Tangerine UI's orange palette, both in dark and light modes.

  • Purple 🪻
    For those of you who like Tangerine UI but want to stick to Mastodon's purple palette.

Tangerine UI's purple variant, both in dark and light modes.

Installation for instance admins

Install Tangerine UI as the only theme on your instance:

  • Copy & paste the contents of TangerineUI.css to the Custom CSS field in the administration panel on your Mastodon instance (Navigate to https://domain/admin/settings/appearance).

⚠️ Caution: Using the 'Custom CSS' field to apply Tangerine UI will prevent all users on your instance from being able to choose another theme in their settings. Please make sure there is a consensus among your users for doing so.
Otherwise, see below how to install Tangerine UI as an optional theme for your users.

Follow these instructions if you wish to add Tangerine UI as an available theme for your users on your instance. This will also allow you to set Tangerine UI as the default theme for your instance, while still letting users change back to Mastodon's default themes in their appearance settings.

  1. Copy the files from this folder in this repository to your Mastodon themes directory app/javascript/styles/:
app/
  javascript/
    styles/
      tangerineui.scss                                | **new**
      tangerineui-purple.scss                         | **new**
        tangerineui/                                  | **new**
          layout-single-column.scss                   | **new**
        tangerineui-purple/                           | **new**
          layout-single-column.scss                   | **new**
  1. Add Tangerine UI to the config. To make Tangerine UI available in your users's settings, you need to add a new line to config/themes.yml. Here we're adding 2 new lines, one for Tangerine UI, another for Tangerine UI's purple variant:
default: styles/application.scss
contrast: styles/contrast.scss
mastodon-light: styles/mastodon-light.scss
tangerineui: styles/tangerineui.scss                  | **new**
tangerineui-purple: styles/tangerineui-purple.scss    | **new**
  1. Add a human-friendly name (optional). You can edit each desired language's locale file in config/locales/[lang].yml to add a localized string name for Tangerine UI. You need to do this for every language you expect your users to use. Otherwise, in their themes list, they will see the unlocalized theme name ("tangerineui-purple"), instead of a readable theme name ("Tangerine UI (Purple)").
themes:
  contrast: Mastodon (High contrast)
  default: Mastodon (Dark)
  mastodon-light: Mastodon (Light)
  tangerineui: Tangerine UI                           | **new**
  tangerineui-purple: Tangerine UI (Purple)           | **new**
  1. Compile theme assets and restart. Run RAILS_ENV=production bundle exec rails assets:precompile and restart your Mastodon instance for the changes to take effect.

Your users should now be able to choose 'Tangerine UI' and 'Tangerine UI (Purple)' as their site theme:

Screenshot : select Tangerine UI as a theme in appearance settings on Mastodon.

As an admin, you should also now be able to set Tangerine UI as the default theme for your instance (navigate to https://domain/admin/settings/appearance):

Screenshot : select Tangerine UI as the default theme for your Mastodon instance in the administration panel.

Installation for regular users

Even if you are not the admin of your instance, you can still use Tangerine UI with a browser extension.

Things to know

  • Tangerine UI currently only supports Mastodon's single column layout. The advanced web interface (multiple columns) will not be affected.
  • Tangerine UI auto-switches from light to dark mode based on your OS preference.
  • Check your Mastodon instance version before using. The latest Mastodon release checked to be compatible is indicated in the CSS file header.
  • If you run a Glitch or Hometown instance, beware: Tangerine UI is currently only meant to be applied on top of Mastodon's vanilla Dark and Light themes.
    • If you are a user on a Glitch instance using a browser extension, first switch your instance to the vanilla flavour before applying Tangerine UI.

Accessibility

  • I have not yet adapted Tangerine to Mastodon's High Contrast theme setting. Please consider that some of your users may depend on it before setting Tangerine UI as the only theme on your instance.

Credits

Huge thanks to Roni Laukkarinen whose work on Mastodon Bird UI I adapted for multiple parts of the redesign. The icon replacement implementations I have also adapted from Bird UI.

<3

If you enjoy Tangerine UI, jobless me would really appreciate a tip 💛!