caxy / styleguide-boilerplate Goto Github PK

Pull all assets that an author needs to edit for their project into a dedicated folder.

Currently, two areas come into play where Sass variables need to be accessed by the styleguide directly: Color Swatches and Breakpoints. Both areas currently require the project's Sass file be imported in with the styleguide's Sass files to function as expected.

Given that both breakpoints and color swatches are rendered in/augmented be the styleguide with JS anyway, it makes sense to handle these variables strictly with JS from the get-go. This will also make the build on the whole be less delicate/setup-dependent, which is a plus.

AC:

• A variable import solution has been found, vetted, and documented within the context of the styleguide
• Imported variables are folded into color swatch creation
• Imported variables are folded into breakpoint display

All SCSS files currently in place should be pulled out to make this a true blank slate styleguide builder, with the following exceptions:

• One or two base classes should be present for reference's sake
• Color swatch example should be in place

Issue arises with using font awesome where it can cause confusion in what assets are present or not in a project that also uses font awesome. Making the imported font more styleguide-specific will alleviate this issue.

Recommendation: assign font name as 'kss-font-awesome' instead of 'font-awesome' when used by the styleguide.

Set up all input fields to have a version with a description and one without.