aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/static/images/README.md
diff options
context:
space:
mode:
authorGravatar hedy <[email protected]>2024-03-16 13:30:45 +0800
committerGravatar hedy <[email protected]>2024-03-16 13:30:45 +0800
commitdac4652de8d175b15f1386e802a857bf907d4d7b (patch)
treee3b6f55ba5e89ef6bd5c16c72ed69638075f69bd /pydis_site/static/images/README.md
parentAdd READMEs to apps/events and templates/events (diff)
parentMerge pull request #1257 from python-discord/dependabot/pip/coverage-7.4.4 (diff)
Merge branch 'main' into feat/events-redesign
Diffstat (limited to 'pydis_site/static/images/README.md')
-rw-r--r--pydis_site/static/images/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/pydis_site/static/images/README.md b/pydis_site/static/images/README.md
new file mode 100644
index 00000000..1d51e8ee
--- /dev/null
+++ b/pydis_site/static/images/README.md
@@ -0,0 +1,14 @@
+# Image assets
+
+The names of each directory correspond to the pages from which apps they are
+used, except for the homepage, which uses `frontpage`, `waves`, `waves_dark`,
+`sponsors`, and `sponsors_dark`.
+
+Directories with the `_dark` suffix store alternate images to the ones in the
+corresponding directory without the `_dark` suffix. When using these alternate
+images, use the `light-image` class for the normal image and the `dark-image`
+class for the image intended for dark mode.
+
+The exception to this is the `waves_dark`, which is used in the homepage hero
+section and the images are set by CSS using `[data-theme="light"]` and
+`[data-theme="dark"]`.