Skip to content
This repository has been archived by the owner on Sep 30, 2022. It is now read-only.

Latest commit

 

History

History
27 lines (18 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.27 KB

UI Styleguides

A curated list of UI styleguides deployed to http://kevinwuhoo.github.io/ui-styleguides/. Selected styleguides contain some combination of UI components, design patterns, icon sets, JS components, and brand guidelines.

Todos

  • make mobile friendly
  • clean up css

Contributing

This list of UI styleguides is a static site generated using middleman, a ruby gem. You'll need ruby, rubygems, and bundler to install middleman and other dependencies. Selenium (specifically ChromeDriver) is used to screenshot the styleguides.

To suggest an additional styleguide, either open an issue with the url of the site, or create a pull request by adding the following fields in data/styleguides.yml:

  • name (site or company name)
  • url (https preferred)
  • color (primary brand color)
  • description (list of attributes; any combination of UI Components, JS Components, Design Patterns, and Icons)

Then run the following rake tasks to fill in remaining required fields, re-screenshot all sites, and regenerate the readme:

bundle exec rake fill_data
bundle exec rake screenshot_guides
bundle exec rake generate_readme