Living Styleguide

Component ID

2176415

Component name

Living Styleguide

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Component created

Component changed

Component body

Overview

This module is a Drupal port of the KSS living styleguide methodology using the Composer library. The module supports CSS and Sass based commenting.
Here are a couple Sublime text comment snippets:
Sass: https://gist.github.com/jeremy-green/8328819
CSS: https://gist.github.com/jeremy-green/8334716

Usage

In this example, the developer has labeled their section (2.1.3), given it a description (A button suitable for giving stars to someone.) and defined the states of the button.

// A button suitable for giving stars to someone.
//
// :hover             - Subtle hover highlight.
// .stars-given       - A highlight indicating you've already given a star.
// .stars-given:hover - Subtle hover highlight on top of stars-given styling.
// .disabled          - Dims the button to indicate it cannot be used.
//
// Styleguide 2.1.3.
a.button.star {
  ...
  &.star-given {
    ...
  }
  &.disabled {
    ...
  }
}

Requirements

Right now, you will need to have Composer installed and run composer install from the module directory.

Links to Documentation

The full documentation and overview can be found here.

Recommended modules

This module is meant to go hand in hand with the Style Guide module.

Credits

The KSS credit goes to Kyle Neath and the Composer package credit goes here. A lot inspiration and code was copied from the Style Guide module.