Skip to content

Commit e8ebe0a

Browse files
trag1ctrag1c
authored
Update docs to match updated logo and color palette (#5283)
![8511](https://github.com/astral-sh/ruff/assets/77130613/862d151f-ff1d-4da8-9230-8dd32f41f197) ## Summary Supersedes #5277, includes redesigned dark mode. ## Test Plan * `python scripts/generate_mkdocs.py` * `mkdocs serve`
1 parent d407165 commit e8ebe0a

File tree

7 files changed

+82
-16
lines changed

7 files changed

+82
-16
lines changed

Diff for: ‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ An extremely fast Python linter, written in Rust.
1414

1515
<p align="center">
1616
<picture align="center">
17-
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/1309177/212613422-7faaf278-706b-4294-ad92-236ffcab3430.svg">
18-
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/1309177/212613257-5f4bca12-6d6b-4c79-9bac-51a4c6d08928.svg">
19-
<img alt="Shows a bar chart with benchmark results." src="https://user-images.githubusercontent.com/1309177/212613257-5f4bca12-6d6b-4c79-9bac-51a4c6d08928.svg">
17+
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/1309177/232603514-c95e9b0f-6b31-43de-9a80-9e844173fd6a.svg">
18+
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/1309177/232603516-4fb4892d-585c-4b20-b810-3db9161831e4.svg">
19+
<img alt="Shows a bar chart with benchmark results." src="https://user-images.githubusercontent.com/1309177/232603516-4fb4892d-585c-4b20-b810-3db9161831e4.svg">
2020
</picture>
2121
</p>
2222

Diff for: ‎docs/assets/bolt.svg

+3
Loading

Diff for: ‎docs/assets/ruff-favicon.png

-26.6 KB
Loading

Diff for: ‎docs/assets/ruff.svg

-6
This file was deleted.

Diff for: ‎docs/stylesheets/extra.css

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
:root {
2+
--black: #261230;
3+
--white: #ffffff;
4+
--astral-purple: #1f092a;
5+
--astral-purple-alt: #30173d;
6+
--light-gray: #826894;
7+
--radiate: #d7ff64;
8+
--flare: #6340ac;
9+
--rock: #78876e;
10+
--galaxy: #261230;
11+
--space: #30173d;
12+
--comet: #6f5d6f;
13+
--cosmic: #de5fe9;
14+
--sun: #ffac2f;
15+
--electron: #46ebe1;
16+
--aurora: #46eb74;
17+
--constellation: #5f6de9;
18+
--neutron: #cff3cf;
19+
--proton: #f6afbc;
20+
--nebula: #cdcbfb;
21+
--supernova: #f1aff6;
22+
--starlight: #f4f4f1;
23+
--lunar: #fbf2fc;
24+
--asteroid: #e3cee3;
25+
--crater: #f0dfdf;
26+
}
27+
28+
[data-md-color-scheme="astral-light"] {
29+
--md-default-bg-color--dark: var(--black);
30+
--md-primary-fg-color: var(--galaxy);
31+
--md-typeset-a-color: var(--flare);
32+
--md-accent-fg-color: var(--cosmic);
33+
}
34+
35+
[data-md-color-scheme="astral-dark"] {
36+
--md-default-bg-color: var(--astral-purple);
37+
--md-default-fg-color: var(--white);
38+
--md-default-fg-color--light: var(--white);
39+
--md-default-fg-color--lighter: var(--white);
40+
--md-primary-fg-color: var(--astral-purple-alt);
41+
--md-primary-bg-color: var(--white);
42+
--md-accent-fg-color: var(--radiate);
43+
44+
--md-typeset-color: var(--white);
45+
--md-typeset-a-color: var(--radiate);
46+
--md-typeset-mark-color: var(--sun);
47+
48+
--md-code-fg-color: var(--white);
49+
--md-code-bg-color: var(--astral-purple-alt);
50+
51+
--md-code-hl-comment-color: var(--light-gray);
52+
--md-code-hl-punctuation-color: var(--light-gray);
53+
--md-code-hl-generic-color: var(--light-gray);
54+
--md-code-hl-variable-color: var(--light-gray);
55+
--md-code-hl-string-color: var(--aurora);
56+
--md-code-hl-keyword-color: var(--sun);
57+
--md-code-hl-operator-color: var(--sun);
58+
--md-code-hl-number-color: hsla(0, 67%, 50%, 1);
59+
--md-code-hl-special-color: hsla(340, 83%, 47%, 1);
60+
--md-code-hl-function-color: var(--cosmic);
61+
--md-code-hl-constant-color: var(--radiate);
62+
--md-code-hl-name-color: var(--md-code-fg-color);
63+
64+
--md-typeset-del-color: hsla(6, 90%, 60%, 0.15);
65+
--md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);
66+
67+
--md-typeset-table-color: hsla(0, 0%, 100%, 0.12);
68+
--md-typeset-table-color--light: hsla(0, 0%, 100%, 0.035);
69+
}

Diff for: ‎mkdocs.template.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: Ruff
22
theme:
33
name: material
4-
logo: assets/ruff.svg
4+
logo: assets/bolt.svg
55
favicon: assets/ruff-favicon.png
66
features:
77
- navigation.instant
@@ -14,14 +14,12 @@ theme:
1414
- content.code.copy
1515
palette:
1616
- media: "(prefers-color-scheme: light)"
17-
scheme: default
18-
primary: red
17+
scheme: astral-light
1918
toggle:
2019
icon: material/weather-sunny
2120
name: Switch to dark mode
2221
- media: "(prefers-color-scheme: dark)"
23-
scheme: slate
24-
primary: red
22+
scheme: astral-dark
2523
toggle:
2624
icon: material/weather-night
2725
name: Switch to light mode
@@ -50,3 +48,5 @@ markdown_extensions:
5048
anchor_linenums: true
5149
plugins:
5250
- search
51+
extra_css:
52+
- stylesheets/extra.css

Diff for: ‎scripts/transform_readme.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
from pathlib import Path
99

1010
URL = "https://user-images.githubusercontent.com/1309177/{}.svg"
11-
URL_LIGHT = URL.format("212613257-5f4bca12-6d6b-4c79-9bac-51a4c6d08928")
12-
URL_DARK = URL.format("212613422-7faaf278-706b-4294-ad92-236ffcab3430")
11+
URL_LIGHT = URL.format("232603516-4fb4892d-585c-4b20-b810-3db9161831e4")
12+
URL_DARK = URL.format("232603514-c95e9b0f-6b31-43de-9a80-9e844173fd6a")
1313

1414
# https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to
1515
GITHUB = f"""

0 commit comments

Comments
 (0)