bluelib/CONTRIBUTING.md

Contributing

Feel free to contribute to bluelib at any time, adding new rules, themes or anything else through pull requests!

Structure

• src contains the project source
  • rules are the Less rules for bluelib, which should use exclusively variables as selectors (@{var} {...})
    • skeleton is always imported, and defines the base rules of bluelib, such as layout, padding, margins, etc.
    • rygblue is a theme: its import is optional, and only defines rules such as fonts and colors
  • vars contains files with Less variables which define the selectors for every rule previously defined
    • module defines selectors only by using unique classes, with the exception of @all, which selects .bluelib *; it's ideal for usage with CSS Modules and React
    • root applies rules to the whole page by applying selectors directly to HTML elements such as section and blockquote; it's ideal for basic websites which do not mix multiple styles
  • targets contains Less files which import a single var file followed by a single rule file, and the CSS files resulting from their compilation
    • rygblue.module.less imports the module var file followed by the rygblue rules file
    • and so on

Compiling

To compile a bluelib target, run:

lessc ${1} ${1%.*}.css --source-map