chore(docs): add dark-themed logo (#137)

* chore(docs): add dark-themed logo * fix(docs): swap themes
jeertmans · Feb 26, 2023 · 8b5db4b · 8b5db4b
1 parent 855c74d
commit 8b5db4b
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
-![Manim Slides Logo](https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo_dark_github.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png">
+  <img alt="Manim Slides Logo" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png">
+</picture>
 
 [![Latest Release][pypi-version-badge]][pypi-version-url]
 [![Python version][pypi-python-version-badge]][pypi-version-url]

diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
diff --git a/docs/source/_static/logo_dark_docs.png b/docs/source/_static/logo_dark_docs.png
diff --git a/docs/source/_static/logo_dark_github.png b/docs/source/_static/logo_dark_github.png
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -7,6 +7,15 @@ og:description: Manim Slides makes creating slides with Manim super easy!
 .. image:: _static/logo.png
     :width: 600px
     :align: center
+    :class: only-light
+    :alt: Manim Slide logo
+```
+
+```{eval-rst}
+.. image:: _static/logo_dark_docs.png
+    :width: 600px
+    :align: center
+    :class: only-dark
     :alt: Manim Slide logo
 ```
 

diff --git a/docs/source/reference/sharing.md b/docs/source/reference/sharing.md
@@ -144,6 +144,6 @@ This is how your are able to watch all the examples on this website. If you want
 to know how to share your slide with GitHub pages, see the
 [workflow file](https://github.com/jeertmans/manim-slides/blob/main/.github/workflows/pages.yml).
 
-> **WARNING:** keep in minde that playing large video files over the internet
+> **WARNING:** keep in mind that playing large video files over the internet
 can take some time, and *glitches* may occur between slide transitions for this
 reason.
diff --git a/static/logo.png b/static/logo.png
diff --git a/static/logo.py b/static/logo.py
@@ -1,17 +1,29 @@
 # flake8: noqa: F403, F405
 # type: ignore
+import os
+
 from manim import *
 
+THEME = os.environ.get("MANIM_SLIDES_THEME", "light").lower().replace("_", "-")
+
 
 class ManimSlidesLogo(Scene):
     def construct(self):
         tex_template = TexTemplate()
         tex_template.add_to_preamble(r"\usepackage{graphicx}\usepackage{fontawesome5}")
-        self.camera.background_color = "#ffffff"
+        self.camera.background_color = {
+            "light": "#ffffff",
+            "dark-docs": "#131416",
+            "dark-github": "#0d1117",
+        }[THEME]
         logo_green = "#87c2a5"
         logo_blue = "#525893"
         logo_red = "#e07a5f"
-        logo_black = "#343434"
+        logo_black = {
+            "light": "#343434",
+            "dark-docs": "#d0d0d0",
+            "dark-github": "#c9d1d9",
+        }[THEME]
         ds_m = MathTex(r"\mathbb{M}", fill_color=logo_black).scale(7)
         ds_m.shift(2.25 * LEFT + 1.5 * UP)
         slides = MathTex(r"\mathbb{S}\text{lides}", fill_color=logo_black).scale(4)

diff --git a/static/logo_dark_docs.png b/static/logo_dark_docs.png
diff --git a/static/logo_dark_github.png b/static/logo_dark_github.png
diff --git a/static/make_logo.sh b/static/make_logo.sh
@@ -0,0 +1,13 @@
+#! /bin/bash
+
+MANIM_SLIDES_THEME=light poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo.png
+
+cp static/logo.png docs/source/_static/logo.png
+
+MANIM_SLIDES_THEME=dark_docs poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_docs.png
+
+cp static/logo_dark_docs.png docs/source/_static/logo_dark_docs.png
+
+MANIM_SLIDES_THEME=dark_github poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_github.png
+
+cp static/logo_dark_github.png docs/source/_static/logo_dark_github.png