Skip to content

Latest commit

 

History

History
146 lines (117 loc) · 3.89 KB

README.md

File metadata and controls

146 lines (117 loc) · 3.89 KB
Raw

Front-end Style Guide

This site is meant to help us unify our front-end code. These are the documented best-practices for front-end code structure. You can help us maintain this project by submitting your own examples of best practices you come across.

You can view the docs site at shaunfox.com/style-guide/

This site is built on Jekyll, a static site generator.

To run Jekyll locally, navigate to the project's folder and run jekyll serve. This will compile your changes and watch for new ones, plus serve your site up at localhost:4000/style-guide/.

How to create a new item in the list

Duplicate a file in the _posts folder and rename to the current date and the name of the section you wish to create.

2016-05-06-dropdowns.markdown

Open the file in your favorite editor and make the same changes in the front-matter of your post. You can add tags, which we'll probably use down the road.

layout: post title: "Dropdowns" date: 2016-05-06 categories: CSS SCSS HTML Javascript

Add content using Markdown. See: this or this.

Content Types

Description

A simple description will help people with context.

Code

Code can be shown with Jekyll's built-in syntax highlighter:

{% highlight html %} [insert code here] {% endhighlight %}

Example

Use an h3 (### Example) to make a header for this section.

Topics we'd like to cover

General Concepts

  • Naming Conventions
  • caniuse.com
  • kagax ES5 and ES6 tables
  • Git
  • Minimalist Philosophy

HTML

  • Buttons
  • Dropdowns
  • Inputs (multiple)
    • Checkboxes
  • Modals
  • Buttons vs Anchor tags
  • General HTML
    • Element Display Behavior
    • Minimal nesting/wrappers
  • HTML Primer
    • Make overall primer with table (deep-link into sections) (Element type, Description, Link)

Javascript

  • ES5 Array functions
  • ES6
  • 'this' in Javascript
  • Global Namespace in Javascript
  • Strict Mode
  • jQuery Primer
  • Angular Primer
  • Syntax

SCSS/CSS

  • General CSS education
    • Make overall primer with table (deep-link into sections) (Name, Description, Common Values, Link)
      • Text Handling
        • font-size
        • font-weight
        • line-height
        • text-align
        • letter-spacing
        • text-transform
        • text-decoration
        • font-family
        • font-style
        • color
        • whitespace
      • Box Model
        • width
        • height
        • padding
        • margin
        • border
        • border-radius
      • Display
        • inline
        • block
        • inline-block
        • table
        • none
      • Layout
        • position (and top, left, right, bottom)
        • float (and clear)
        • z-index
        • vertical-align
        • transform (and transform-style)
      • SVG
        • fill
      • Selectors
      • Psuedo elements
        • content (and psuedo elements)
        • before
        • after
      • Psudoselectors
        • hover
        • active
        • disabled
        • last-child
        • first-child
        • nth-child
      • Background (and background-color) ---
      • cursor ---
      • overflow ---
      • opacity ---
      • box-shadow ---
      • Break these out into their own sections
        • SCSS Variables
        • Color Variables and Functions
        • Mixins
        • Nesting in SCSS
        • Functions in SCSS
        • CSS Problem Solving
        • Inline Styling
        • Pseudo Element Primer
        • CSS Transitions