{"id":13606218,"url":"https://github.com/csalmeida/protonmail-themes","last_synced_at":"2025-04-12T08:30:42.373Z","repository":{"id":32697712,"uuid":"36287067","full_name":"csalmeida/protonmail-themes","owner":"csalmeida","description":"Customise ProtonMail with themes and enhance your encrypted email experience.","archived":true,"fork":false,"pushed_at":"2021-10-31T00:48:17.000Z","size":33206,"stargazers_count":424,"open_issues_count":0,"forks_count":106,"subscribers_count":21,"default_branch":"main","last_synced_at":"2024-11-07T11:43:58.297Z","etag":null,"topics":["css","protonmail","themes"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csalmeida.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"csalmeida","ko_fi":"csalmeida","custom":"https://www.paypal.me/csalmeida/5"}},"created_at":"2015-05-26T09:53:21.000Z","updated_at":"2024-10-08T11:14:37.000Z","dependencies_parsed_at":"2022-09-11T10:21:58.493Z","dependency_job_id":null,"html_url":"https://github.com/csalmeida/protonmail-themes","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csalmeida%2Fprotonmail-themes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csalmeida%2Fprotonmail-themes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csalmeida%2Fprotonmail-themes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csalmeida%2Fprotonmail-themes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csalmeida","download_url":"https://codeload.github.com/csalmeida/protonmail-themes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248539753,"owners_count":21121228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","protonmail","themes"],"created_at":"2024-08-01T19:01:07.176Z","updated_at":"2025-04-12T08:30:37.365Z","avatar_url":"https://github.com/csalmeida.png","language":"CSS","funding_links":["https://github.com/sponsors/csalmeida","https://ko-fi.com/csalmeida","https://www.paypal.me/csalmeida/5","https://www.paypal.me/csalmeida/5'"],"categories":["CSS"],"sub_categories":[],"readme":"# ProtonMail Themes\nSince [v1.16](https://blog.protonmail.ch/protonmail-beta-v1-16-release-notes/), the encrypted mail service allows the use of themes with Cascading Style Sheets. You can pick a theme from the [Themes](themes/) folder or create a custom one yourself using CSS. Feel free to [use the theme template provided](templates/theme_example) as a starting point.\n\n\u003e These themes were developed for **[v4.0.x](https://github.com/csalmeida/protonmail-themes/releases)** of ProtonMail.\n\n## Table of contents\n\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand contents\u003c/summary\u003e\n\n- [How to use a theme](#how-to-use-a-theme)\n- [Available themes](#available-themes)\n  - [Do these themes compromise security?](#do-these-themes-compromise-security)\n- [Quick setup guide](#quick-setup-guide)\n- [Feedback and fixes](#feedback-and-fixes)\n- [Supporting and maintaining the project](#supporting-and-maintaining-the-project)\n- [Frequently Asked Questions](#frequently-asked-questions)\n- [Where can I find more themes?](#where-can-i-find-more-themes)\n- [Web References](#web-references)\n\n#### Documentation 📖\n\n- [Documentation](#documentation)\n  - [Quick Setup Guide](docs/README.md#quick-setup-guide)\n  - [Creating a theme](docs/README.md#creating-a-theme)\n  - [Themes](docs/README.md#themes)\n  - [Templates](docs/README.md#templates)\n  - [Theme Compilation](docs/README.md#theme-compilation)\n  - [Contributing](docs/README.md#contributing)\n  - [Is there something missing?](docs/README.md#is-there-something-missing)\n- [Project's README](../README.md)\n- [Theme Template Guide](./theme-template-guide.md)\n- [Theme Versioning](./theme-versioning.md)\n\u003c/details\u003e\n\n\n### How to use a theme\n1. Pick one from the themes folder in the repository.\n1. Select the theme and select the raw view to see all the code.\n1. Select all and copy the code.\n1. Install the [Stylus](https://github.com/openstyles/stylus#releases) browser if not done already.\n1. Add a new style in *Stylus* and paste the code in the text area.\n1. Below the text area select from the *Applies to* dropdown *\"URLs on the domain\"* and add `protonmail.com` as a value and press save.\n1. Select the added theme in Stylus' Manage panel to enable it.\n\n\u003e *In order to remove a theme, open Stylus, click Manage, and untick the box of the theme or remove it altogether by pressing `X`.*\n\nThe theme should be applied and you should see the changes immediately.\n\n### Available themes\nCheck out some of the available themes you can choose from.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eExpand theme list\u003c/b\u003e 👩🏻‍🎨\u003c/summary\u003e\n\n#### [Green Lume](themes/green_lume)\n\n![Screenshot of Green Lume theme.](screenshots/green_lume.png)\n\n#### [Vitamin C](themes/vitamin_c)\n\n![Screenshot of Vitamin C theme.](screenshots/vitamin_c.png)\n\n#### [Dark Bubble Gum](themes/dark_bubble_gum)\n\n![Screenshot of Dark Bubble Gum theme.](screenshots/dark_bubble_gum.png)\n\n\n#### [Blue and Orange](themes/blue_and_orange)\n\n![Screenshot of Blue and Orange theme.](screenshots/blue_and_orange.png)\n\n#### [Ochin](themes/ochin)\n\n![Screenshot of Ochin theme.](screenshots/ochin.png)\n\n#### [Dracula](themes/dracula)\n\n![Screenshot of Dracula theme.](screenshots/dracula.png)\n\n#### [Monokai](themes/monokai)\n\n![Screenshot of Monokai theme.](screenshots/monokai.png)\n\n#### [Deutera One](themes/deutera_one)\n\n![Screenshot of Deutera One theme.](screenshots/deutera_one.png)\n\n#### [Gruvbox](themes/gruvbox)\n\n![Screenshot of Gruvbox theme.](screenshots/gruvbox.png)\n\n\n### [Nord](themes/nord)\n\n![Screenshot of Nord theme.](screenshots/nord.png)\n\n\u003c/details\u003e\n\n## Quick setup guide\n\n\u003e **Required for theme creation only**\n\nInstall [NodeJS](https://nodejs.org/en/), after forking/cloning this repository install dependencies:\n\n```bash\ncd protonmail-themes\n# Requires Node v15.2.1, run `nvm use` to set the correct version. \nnpm install\n```\n\nThemes can be created by duplicating and renaming the [example theme folder](templates/theme_example) and its `.scss` file to the theme name. Then edit that file by changing the color variables. You can also extend the theme by editing the `_styles.css` partial or by creating a custom one.\n\nTwo commands are available to compile themes:\n```\n*// Compiles themes as changes are made.*\nnpm run watch\n\n*// Compiles all themes.*\nnpm run build\n```\n\n## Container Setup with Docker\n\n1. [Install Docker](https://docs.docker.com/engine/install/). For MacOS and Windows, [Docker Desktop](https://docs.docker.com/engine/install/#desktop) is recommended instead.\n1. Run `docker compose up -d`. This will run the development environment.\n\nRebuild and run Docker container from a clean slate with with:\n\n```bash\n# Change directory into the project.\ncd protonmail-themes\n```\n\n```bash\ndocker compose rm \u0026\u0026\ndocker compose pull \u0026\u0026\ndocker compose build --no-cache \u0026\u0026\ndocker compose up -d --force-recreate\n```\n\n**Additional notes:**\n\n- To examine the container run `docker ps`.\n- To stop the container run `docker compose down`.\n- The container will run a Node image with the version this project supports along with the dependencies. Then it will run the watch command so themes can be compiled as changes are made.\n- When using **Windows Subsystem Linux**, cloning the repo into a folder inside `/home/` directory of you distro of choice is reccomended since mounted drivers and folders (i.e `/mnt/c`) won't issue a file change event.\n\n### Feedback and fixes\nIf you notice something's missing feel free to make a pull request. If you have no time to fix it please open an issue.\n\n### Supporting and maintaining the project\nProtonMail is a great email service, I enjoy working on the project and provide themes for all. Please consider making a small donation, just the price of a cup of coffee *goes a long way* to help me maintain it and keep adding color to your private email experience! Thank you 🙇🏻\n\n\u003ca href='https://www.paypal.me/csalmeida/5'\u003e\n\u003cimg src='https://getflywheel.com/wp-content/uploads/2015/10/paypal-donate-button-large.png' alt='PayPal Me' width='160' /\u003e\n\u003c/a\u003e\n\n### Frequently Asked Questions\n\n#### Do these themes compromise security?\nIn short, no. All themes listed here will always style existing elements from ProtonMail's UI and not import any third party files from anywhere.\nAt the time I created these themes I've received a few directions from ProtonMail's co-founder [Jason Stockman](https://twitter.com/jasonstockman) in order to avoid breaking layout and security issues.\n#### Why is Stylus required to use custom themes?\n\nSupport for custom themes in ProtonMail's appearance settings [seems to have been disabled in `~v4.0.0 beta 33`](https://www.reddit.com/r/ProtonMail/comments/j2l1im/protonmail_beta_41_removes_ability_to_use_and/g767k97/?context=3).\n\nTo use custom themes an alternative needs to be used to load the stylesheet. [Stylus](https://github.com/openstyles/stylus#releases) has been recommended but any other alternative should work.\n\n#### Where can I find more themes?\n* [ProtonMail's Official Themes](http://protonmail.tumblr.com/)\n* [Austin Delamar's ProtonMail Themes](https://github.com/amdelamar/pm-theme)\n* [Jérémie Cook's ProtonMail Theme](https://github.com/jeremiecook/protonmail-theme)\n* [Quark, a theme creator for ProtonMail](https://github.com/csalmeida/quark)\n\n#### Web References\n* [The Green Lume theme got featured on ProtonMail's website](https://protonmail.com/blog/protonmail-themes/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsalmeida%2Fprotonmail-themes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsalmeida%2Fprotonmail-themes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsalmeida%2Fprotonmail-themes/lists"}