Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 4.58 KB

README.md

File metadata and controls

75 lines (48 loc) · 4.58 KB
Raw

A Jekyll (OO)CSS Styleguide

Easily generate a (themed) CSS Styleguide—or 'Pattern Library'—with Jekyll. Included GulpJS workflow with Sass compilation, autoprefixer, auto-building and browsersync.

Themed Styleguide example

To add a new Component, simply create a new markdown (.md or .html) file with the HTML for your component in the posts/components folder and run jekyll build (or use the included GulpJS script).

Then add your project's CSS file to Jekyll Styleguide (or @import is in its app.scss) and see how these components render.

Notice how the *included* project CSS is applied to the content (white area)? In the website example you'll see my DH kickstart-style styles. If you have not (yet) included *your* styles in static/scss/app.scss you'll see unstyled text. Jekyll Styleguide themes do not interfere with your project's CSS.

Table Of Contents

Overview

  • Creates a simple Pattern Library of HTML components in posts/components.
  • @import your Sass files in static/scss/app.scss...
    • ...or just add your.css to _includes/head.html
  • Source Highlighting through PrismJS
  • [Optional] GulpJS workflow (compile Sass, concat and autoprefix, auto-run Jekyll)
  • [Optional] Themes: see static/scss/themes/

Requirements

So, I basically created this for myself. I am on a Mac. This probably works on Windows and \*nix but you'd have to probably change a bunch of stuff. So, these instructions are Mac only a.t.m. Sorry.

Jekyll requires Ruby, Rubygems and a Linux, Unix or Mac OSX system. If you do not yet have those installed—and are on Mac OSX—I strongly advise you to install those as follows:

Note: Skip these steps if you already have the needed tools (Ruby, Gems, etc) installed. Avoid using sudo

  1. Make sure you have the OSX Xcode Command Line Tools installed
  2. Install Ruby via RVM:
    \curl -sSL https://get.rvm.io | bash -s stable

Installation

Now you should have all the requirements for installing Jekyll. The GulpJS workflow requires NodeJS, NPM and a bunch of Gulp plugins. But let's ignore those and start simple, OK?

  1. Install Jekyll: gem update --system && gem install jekyll
  2. Download or git clone [email protected]:davidhund/jekyll-styleguide.git
  3. Add your colors in colors/index.md
  4. Add your components in posts/components/
  5. Run Jekyll: jekyll build --config=_config.dev.yml
  6. Go to 4. and repeat...

Usage

Take a look at the _config.dev.yml (_config.yml) to set some global variables such as the baseurl, name and version of your Style Guide, a link to the repository etc.

Gulp

I've added an experimental GulpJS workflow—GruntJS should be very similar—to automate re-generating the Styleguide, while compiling your Sass files, Concatenating your JS, etc.

To install and use Gulp (you should be at the root of the project, in a command prompt):

  1. npm install -g gulp to install Gulp globally
  2. npm install to install all needed Gulp plugins
  3. Simply run gulp: this fires up a local webserver and watches your Sass, JS and components.
  4. Now go change some files, save, and watch your browser autoreload ;)

Troubleshooting

  • Using the Gulp task, sometimes jekyll child processes crap out and keep running (multiple) in the background. This could cause issues. One way to kill all of those child processes, and start over, is to stop the Gulp task (CTRL+C) and do: ps aux | awk '/jekyll/ {print $2}' | xargs kill

Check out the defined Colors or Components