Giter Club home page Giter Club logo

mcforge_web's Introduction

Forge Web

This repository serves as central hub for all things web and Forge. This includes stylesheets, images and scripts for Forge sites such as the docs and the forums.

SASS Structure

To ensure that the look and feel across all sites is consistent, we heavily rely on the SASS preprocessor to modularize and automatically generate our stylesheets.

Hence, you will find a specific structure when looking at the stylesheets:

  • Only files without an underscore prefix will get deployed to the sites and are the place where all other components come together. These files should stay as they are right now unless new modules are added or old ones removed.
  • Files with an underscore make up discrete modules of the stylesheets, their name specifies each module's purpose.
  • Files with a 'theme' prefix serve as mere variable references to allow for flexible and easy switching of color themes.
  • Files with a 'styles' prefix serve as combinations of multiple modules along with the respective themes, while the simple 'styles.scss' file is the location where generic styles are brought together.
  • Files with a 'screens' suffix generally contain nothing but media queries that specify adjustments for different screen and device sizes.

Contribution Guidelines

Contributions such as fixes or additions to the stylesheets are welcome, but they should adhere to the following rules:

  • The sites make heavy use of the flexbox model. Its capabilities should be used to the fullest rather than relying on hacks simply to work in old browsers.
  • Colors mustn't be hardcoded unless they work well across all themes. Either stick to the current color palette and use the theme variables or, if no other way is possible, introduce a new theme variable.
  • All dimensional measurements must be specified in rem or as a percentage. This ensures a consistent look and will make potential font sizes changes less of a hassle.
  • Unless absolutely necessary, new modules or edits to the deployment files should be avoided. Changes should go into an appropriate file, but one shouldn't need to look for a single change in too many files.
  • Use of all capabilities of SASS is helpful. Try to nest things where a hierarchy is given and comment the topmost element accordingly.

mcforge_web's People

Contributors

marvin-roesch avatar lexmanos avatar busti avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.