1
0
Fork 0
Documenting resources related to front-end style guides and pattern libraries
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Brad Frost 2f67e2e8af
Delete vladshap.md
5 months ago
_includes Add link to huffduffer 5 years ago
_layouts add functionality for seasons in podcasts 5 years ago
_patterns Add transcript to patterns 8 years ago
_podcast Publish Maya Benari's podcast episode 5 years ago
_resourcearticle Merge pull request #423 from whitingx/gh-pages 2 years ago
_resourcebook Add book: Expressive Design Systems 2 years ago
_resourceexample Delete vladshap.md 5 months ago
_resourcepodcast Add patterns day podcasts 5 years ago
_resourcetalk Added malvid and atomizedesign to tools. Added design system fluxible to talks. 4 years ago
_resourcetool Rowe Morehouse: Add Radix design system and Radix Icons. 2 years ago
_sass Publish Maya Benari's podcast episode 5 years ago
css Add lazyloading of images 6 years ago
images Add screenshot for Jøkul design system 2 years ago
podcast Add correct link to project 5 years ago
scripts Improve homepage performance 5 years ago
.gitignore feat: add a Gemfile to the repo 6 years ago
CNAME Update CNAME 8 years ago
Gemfile fix: Gemfile & Gemfile.lock to reduce vulnerabilities 2 years ago
Gemfile.lock fix: Gemfile.lock to reduce vulnerabilities 2 years ago
README.md Medium Retrospective 3 years ago
_config.yml Move podcast to podcasts page 6 years ago
add.html Buncha improvements 6 years ago
articles.html Stuff for the thing 6 years ago
books.html Stuff for the thing 6 years ago
contributors.html Stuff for the thing 6 years ago
examples.html Stuff for the thing 6 years ago
favicon.ico Add favicon 8 years ago
feed.xml Add initial files 8 years ago
index.html fix: missing space 6 years ago
podcasts.html Add link to huffduffer 5 years ago
styleguide.html Get site set up for podcasts 8 years ago
talks.html Stuff for the thing 6 years ago
tools.html Stuff for the thing 6 years ago

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…

bundle exec 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.