Documenting resources related to front-end style guides and pattern libraries
HTML CSS Other
Switch branches/tags
Nothing to show
Clone or download
Latest commit 1f8fc0d Jul 19, 2018
Permalink
Failed to load latest commit information.
_includes Add link to huffduffer Jul 2, 2017
_layouts add functionality for seasons in podcasts Jun 19, 2017
_patterns Add transcript to patterns Jan 22, 2015
_podcast Publish Maya Benari's podcast episode Nov 19, 2017
_resourcearticle Merge branch 'gh-pages' into gh-pages Apr 16, 2018
_resourcebook Merge pull request #402 from frostyweather/gh-pages Dec 8, 2017
_resourceexample Add GOV.UK Design System Jul 19, 2018
_resourcepodcast Add patterns day podcasts Jul 2, 2017
_resourcetalk Added malvid and atomizedesign to tools. Added design system fluxible… Jul 9, 2018
_resourcetool Merge pull request #439 from pmccloghrylaing/uiengine-frontmatter Jul 16, 2018
_sass Publish Maya Benari's podcast episode Nov 19, 2017
css Add lazyloading of images Dec 30, 2016
images Updated Vanilla example Jul 17, 2018
podcast Add correct link to project Nov 20, 2017
scripts Improve homepage performance Mar 18, 2017
.gitignore feat: add a Gemfile to the repo Dec 28, 2016
CNAME Update CNAME Nov 18, 2014
Gemfile feat: add a Gemfile to the repo Dec 28, 2016
Gemfile.lock revert Gemfile.lock changes Jul 30, 2017
README.md Tidy up Mar 31, 2015
_config.yml Move podcast to podcasts page Dec 30, 2016
add.html Buncha improvements Dec 30, 2016
articles.html Stuff for the thing Dec 30, 2016
books.html Stuff for the thing Dec 30, 2016
contributors.html Stuff for the thing Dec 30, 2016
examples.html Stuff for the thing Dec 30, 2016
favicon.ico Add favicon Nov 18, 2014
feed.xml Add initial files Nov 14, 2014
index.html fix: missing space Jan 29, 2017
podcasts.html Add link to huffduffer Jul 2, 2017
styleguide.html Get site set up for podcasts Jan 22, 2015
talks.html Stuff for the thing Dec 30, 2016
tools.html Stuff for the thing Dec 30, 2016

README.md

Style Guide Resources

http://styleguides.io/

This site lists lots of useful resources to help you learn about and create your own Front-End Style Guides and Pattern Libraries.

Best of all, you can add your own resources to share with others. And you don’t even need to download any files to do that, you can do it all within GitHub’s web interface.

To do

  • Add screenshots to resources that are examples
  • Additional hover state to resources that doesn’t rely on transform
  • Transfer all the resources from Gimmiebar
  • Set up a domain
  • Set up tags and filters

How to add resources the easy way

The site uses a templating system called Jekyll that generates static HTML files, and makes it easy (hopefully) to add files that share the same template. GitHub plays nicely with Jekyll, and lets you add and edit files using the web interface. So no need to download anything, you can do it straight in repository on GitHub.

First, you’ll need to decide whether your resource is a book, article, tool, podcast, guide, example, or talk.

The only folders you’ll need to worry about are:

  • _resourcearticle
  • _resourcebook
  • _resourceexample
  • _resourcepodcast
  • _resourcetalk
  • _resourcetool

If it’s a tool, open up the _resourcetool folder. In there, you’ll find a README that’ll explain exactly what to do to.

How to add resources the hard way

If you want to get this repo running locally on your machine, you’ll need to get set up with Jekyll.

To install Jekyll, open up your command line and type…

gem install jekyll

…then…

jekyll serve

…to get the server address where the static files are built. You only need to worry about the files in the folders prefixed by _resource, and you can follow the instructions in the README in each folder if you’re not sure what to do.