Giter Club home page Giter Club logo

styleguide-starter-kit's Introduction

styleguide-starter-kit

Style guide generated from the stater kit
Demo using the style guide

What is it?

It is boilerplate style guide. It includes the following:

  • boilerplate pattern library in CSS (includes CSS for colors, type, buttons, cards, spinners, layouts, layers,...). This can be edited to match your product's branding.
  • postcss-style-guide for generating a style guide from the pattern library
  • gulp as task runner to monitor for changes in CSS and regenerate style guide

How is the pattern library a.k.a stylesheets structured?

They are grouped in to three categories:

  • Atoms - Colors, Typography, Buttons
  • Molecules - Cards, Spinners, Input Controls, Tabs
  • Infrastructure - Layouts, Layers

How do I use it?

  • npm i -g styleguide-starter-kit
  • In the project directory, run: create-styleguide

It generates a styleguide folder in your project with the following:

  • styles: includes all the pattern library CSS
  • styleguide-template: template used for generating the style guide
  • gulpfile: task runner
  • public: includes the styleguide, a demo with the styleguide and the styleguide.min.css if you want to consume all of it in your site.

See it in action

  • Go in to the styleguide folder and try npm run start
  • You can now view your style guide in http://localhost:4500
  • There is also a demo in http://localhost:4500/demo

Set it up to run within your project

You can include the following in your package.json to include the style guide tasks as well:

"scripts": {
   "start": "node ./index.js & npm run start --prefix ./styleguide"
 },

Report Issues

Please log issues here

styleguide-starter-kit's People

Contributors

archana-s avatar

Watchers

E Jenkins 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.