From 78f8b208e440327204041ba646f1813b4239b9dd Mon Sep 17 00:00:00 2001 From: Arkerthan <arkerthan@gmail.com> Date: Mon, 28 Dec 2020 15:53:26 +0100 Subject: [PATCH] Add documentation to CSS module --- css/css.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 css/css.md diff --git a/css/css.md b/css/css.md new file mode 100644 index 00000000000..f259684518e --- /dev/null +++ b/css/css.md @@ -0,0 +1,22 @@ +# CSS module + +This directory contains ALL style files for this project. + +## Structure + +Most of the structure should be self-explanatory, this is a list of the main rules when adding new styles + +* `general/`: Only Styles that can be used in many different places and are not part of a specific system may be added + here. + +* When adding styles that are only used in one place put them in a directory that matches the top directory of the + corresponding JS file in `src/` or `js/`. + +* There is no catch-all file, if there is no place where your style goes create one instead of mixing them together with + unrelated styles. This does mean there are many small files, but properly sorted and named this is preferable to one + large catch-all file. + +## Compiling + +During compiling all CSS files in this directory get combined and then added as a module, which means the styles are put +directly into <head> element of the final HTML file. -- GitLab