Skip to content

docs: Use GitHub markdown alerts #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Use GitHub markdown alerts #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
369cb7a
docs: Use GitHub markdown alerts
oSumAtrIX Apr 15, 2024
0019227
docs: Mention good contrast requirement (#32)
validcube Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,39 +60,40 @@

# 🖌️ ReVanced brand guidelines

This repository contains guidelines, kits and various other assets to help you use core brand elements of ReVanced.
This repository contains guidelines, kits and other assets to help you use core brand elements of ReVanced.

> **Note**: Specifications are in their early stage of development and might heavily change a lot in their first revisions.
> [!NOTE]
> Specifications are in their early stage of development and might heavily change a lot in their first revisions.

## 🖼️ ReVanced logo

### 🚩 The basics

The ReVanced logo is the most recognizable asset which is why it is important to follow certain rules when used:
The ReVanced logo is the most recognizable asset, which is why it is important to follow certain rules when used:

- Do not alter, rotate, or modify the logo. Exceptions apply below
- Do not animate the logo
- Use the latest revision of the logo available at all time

### 🎨 Colors

The ReVanced logo has a triadic gradients which defines its character. The ring as well as the logo feature a top-to-bottom gradient blending the colors <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146503-fbc21584-94a5-436b-9277-3c64a72baf97.png"/> `#F04E98`, <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146541-fcb07e8d-9ba4-4292-b633-f64a01b80341.png"/> `#5F65D4`, and <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146582-18441902-b968-434c-bc40-f78bf975e86c.png"/> `#4E98F0`.
The ReVanced logo has a triadic gradient which defines its character. The ring as well as the logo feature a top-to-bottom gradient blending the colors <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146503-fbc21584-94a5-436b-9277-3c64a72baf97.png"/> `#F04E98`, <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146541-fcb07e8d-9ba4-4292-b633-f64a01b80341.png"/> `#5F65D4`, and <img height="16px" src="https://github-production-user-asset-6210df.s3.amazonaws.com/47723802/243146582-18441902-b968-434c-bc40-f78bf975e86c.png"/> `#4E98F0`.

The ReVanced logo should appear in single shades of black and white, but the diamond may appear in any color. On a dark background, a light shade and vice versa should be used.
The ReVanced logo should appear in single shades of black and white, but the diamond may appear in any color. A light shade and vice versa should be used on a dark background.

### 📏 Spacing

The ReVanced logo should have a minimum margin of 15% of its original size. If there is a headline accompanying the logo, the margin of the logo and headline together should be increased.
The ReVanced logo should have a minimum margin of 15% of its original size. If a headline accompanies the logo, the margin of the logo and headline should be increased together.

### ☝️ Headline

The ReVanced logo should be accompanied with a headline of any typeface, preferably [Manrope](assets/revanced-typeface/manrope), starting with the [wordmark](assets/revanced-wordmark) on the right or below the logo only.
The ReVanced logo should be accompanied by a headline of any typeface, preferably [Manrope](assets/revanced-typeface/manrope), starting with the [wordmark](assets/revanced-wordmark) on the right or below the logo only.

The headline should appear in single shades of black and white. On a dark background, a light shade and vice versa should be used. The ReVanced logo should only be used in its entirety while accompanied with a headline.
The headline should appear in single shades of black and white. A light shade and vice versa should be used on a dark background. The ReVanced logo should only be used in its entirety while accompanied by a headline.

### 🌐 Socials

Any border radius may be used for the ReVanced logo.
Any border-radius may be used for the ReVanced logo.

### ❌ Misuse

Expand All @@ -106,20 +107,22 @@ Any border radius may be used for the ReVanced logo.
- Don't change color
- Don't accompany the logo with a headline starting with anything other than the wordmark
- Don't overemphasize the logo
- Don't place the logo or a variant on a background with low contrast

### 🔨 Application

Todo.

## 🔤 ReVanced marks

The ReVanced marks include, but are not limited to
The ReVanced marks include but are not limited to

- The ReVanced name
- The ReVanced logo
- Anything that includes ReVanced in the name

> **Note**: No letter except R and V in "ReVanced" should be capitalized.
> [!IMPORTANT]
> No letter except R and V in "ReVanced" should be capitalized.

## 📜 ReVanced tagline

Expand All @@ -128,4 +131,5 @@ The following taglines should be used whenever a slogan, summary, or short descr
- "Continuing the legacy of Vanced"
- "Continuing the legacy of Vanced at revanced.app"

> **Note**: The tagline may end with punctuation when necessary.
> [!NOTE]
> The tagline may end with punctuation when necessary.