Giter VIP home page Giter VIP logo

style-guide's Introduction

nGen Works style guide template

========================================

A template to create simple website style guides.

Add, remove, or modify the markup in guide.html to your liking, then style accordingly.

Includes some starter styles that you can use as a starting point or throw out. The important part is the HTML file, which includes a comprehensive list of common elements used in web projects.

Acts as a great starting point for designing your type conventions, form elements, and other site modules wihout the wasteful, inaccurate, and evil crutch of Photoshop.

I use this very early in my design process. It works nice as an early design deliverable and can be applied directly to your site. (I would normally apply these styles to our Live Wires wireframe/prototype). Saves time, looks great, and get's you thinking about designing systems rather than pages.

Instructions

(If you wish to start with these styles)

  1. Drop these files in your web project and adjust config.rb to line up with your desired folder layout (I like to keep my scss folder above the webroot and have it compile into httpdocs/css).
  2. Setup Codekit, Compass.app or similar to watch config.rb and compile the starter styles.
  3. Open httpdocs/guide.html in your browser to view the style guide.
  4. Set colours, typefaces, grid variables, etc in source/scss/settings/_variables.scss
  5. Fine tune typography, forms, tables, callouts, etc in source/scss/ui
  6. Adjust the style guide itself in source/scss/pages/style-guide.scss (setup colour swatches, font order, grids shown, etc)

Everything should compile into two CSS files:

httpdocs/css/style.css combines everything except source/scss/pages/style-guide.scss for direct use in your website.

httpdocs/css/style-guide.css is compiled from source/scss/pages/style-guide.scss which only applies to the style guide page itself.

Remember, this is just a suggested starting point to get you going. Go ahead and add or remove sections as needed. If you don't like the defaults, go ahead and fork your own version.

Read how I use this in my design workflow

Acknowledgements

This library uses the following:

Huge thanks to the people that work on these great tools and release them to the world for free. Also, thanks to:

style-guide's People

Contributors

louderthan10 avatar

Watchers

Bohnna Chhim avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.