diff options
author | 2024-02-13 14:26:23 +0800 | |
---|---|---|
committer | 2024-02-13 14:26:23 +0800 | |
commit | 212161c1b3f890d56cbfda0e1422e2cec06f3fcd (patch) | |
tree | 420c5fab38230f61cc9452056c6958fe0049c621 /pydis_site/static | |
parent | Merge pull request #1228 from python-discord/resources_config_ready (diff) |
Add docs on Bulma, colors, dark mode, and CSS for development
Diffstat (limited to 'pydis_site/static')
-rw-r--r-- | pydis_site/static/css/README.md | 28 | ||||
-rw-r--r-- | pydis_site/static/images/README.md | 14 |
2 files changed, 42 insertions, 0 deletions
diff --git a/pydis_site/static/css/README.md b/pydis_site/static/css/README.md new file mode 100644 index 00000000..24b81435 --- /dev/null +++ b/pydis_site/static/css/README.md @@ -0,0 +1,28 @@ +# Static CSS files + +When styling components, oftentimes you can make good use of Bulma classes +rather than hardcoding CSS rules: + +- [Bulma color helpers](https://bulma.io/documentation/helpers/color-helpers/): + Classes that can be added to pretty much all Bulma components to give them a + text or background color which are defined in [`BULMA_SETTINGS`](../settings.py). +- [Bulma typography helpers](https://bulma.io/documentation/helpers/typography-helpers/): + Classes you can add to divs and text elements to adjust the text properties + and alignment. +- [Bulma visibility helpers](https://bulma.io/documentation/helpers/visibility-helpers/): + Rather than hardcoding screen width cutoffs just to adjust visibility, use + these classes instead as they are more descriptive and provide more + flexibility. + +To adjust Bulma variables (including color, sizes, margins) for a Bulma class +everywhere, adjust the variables in [`BULMA_SETTINGS`](../../settings.py) where +applicable. The [Bulma +Variables](https://bulma.io/documentation/customize/variables/) page describes +the list of all variables and their default values. + +That said, however, sometimes Bulma does not provide a good generalized +solution for a specific use case or for a specific element. In that case, use +CSS selectors to ensure that other elements that should not be styled are not +affected by the rule, and when working with colors, ensure both light and dark +modes are supported. Use `[data-theme="light"]` and `[data-theme="dark"]` to +style elements for specific themes. 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"]`. |