Choose the Sass extends, functions, and mixins from /foundation
to include in your MVCSS project.
Extends
// ----- Extend Name ----- //
.extend
// ...
Functions
// ----- Function Name ----- //
// -> Description
//
// $arg - the argument description
@function name($arg)
// ...
Mixins
// ----- Mixin Name ----- //
// -> Description
//
// $arg - the argument description
=name($arg)
// ...
Tools
// -------------------------------------
// Tool Section Name
// -------------------------------------
.name
// ...
Choose the Sass components from /components
to include in your MVCSS project.
// *************************************
//
// Component
// -> Description
//
// -------------------------------------
// Template (Haml)
// -------------------------------------
//
// .has-context
//
// .component[modifier](state)
//
// .component-scaffolding
//
// *************************************
// -------------------------------------
// Helpers
// -------------------------------------
// ...
// -------------------------------------
// Variables
// -------------------------------------
// ----- Colors ----- //
// ... (with the !default flag)
// ----- Sizing ----- //
// ... (with the !default flag)
// -------------------------------------
// Base
// -------------------------------------
.component
// ...
// -------------------------------------
// Modifiers
// -------------------------------------
// ----- Modifier Name ----- //
.component--modifier
// ...
// -------------------------------------
// Scaffolding
// -------------------------------------
// ----- Scaffolding Name ----- //
.component-scaffolding
// ...
Choose the Sass structures from /structures
to include in your MVCSS project.
// *************************************
//
// Structure
// -> Description
//
// -------------------------------------
// Dependencies
// -------------------------------------
//
// - components/grid
//
// -------------------------------------
// Template (Haml)
// -------------------------------------
//
// .has-context
//
// .structure[modifier](state)
//
// .structure-scaffolding
//
// *************************************
// -------------------------------------
// Helpers
// -------------------------------------
// ...
// -------------------------------------
// Variables
// -------------------------------------
// ----- Colors ----- //
// ... (with the !default flag)
// ----- Sizing ----- //
// ... (with the !default flag)
// -------------------------------------
// Base
// -------------------------------------
.component
// ...
// -------------------------------------
// Modifiers
// -------------------------------------
// ----- Modifier Name ----- //
.component--modifier
// ...
// -------------------------------------
// Scaffolding
// -------------------------------------
// ----- Scaffolding Name ----- //
.structure-scaffolding
// ...
The documentation, for anything that requires more full documentation than the source file, is included in /docs
.
We use Semantic Versioning for all versioning. When you make a Major, Minor, or Patch update, you'll need to the do the following:
- Update the
CHANGELOG.md
file - Add the new tag locally
- Push the tag (along with your commit(s))