Menu

For Designers & Developers

Install Jekyll, build UI components in HTML with styles and assets attached, add documentation.

Installation

To use this living styleguide on your project, you’ll need to download Jekyll (version 3.1 or higher).

Download the living styleguide files from Github.

File Structure

Living_Styleguide/

├── .gitignore
├── _config.yml
├── index.md
├── README.md
├── LICENSE
├── src/
│   └── assets/
│   │   ├── _scss
│   │   ├── branding
│   │   ├── css
│   │   └── fonts
│   └── html/
│   │   ├── 01-components/
│   │   │   ├── ...
│   │   └── 02-examples/
│   │       └── ...
|   └── design_source/
│       └── ...
├── styleguide/
│   ├── _scss
│   ├── branding
│   ├── css
│   └── fonts
├── _docs/
│   ├── 00-branding/
│   │   ├── color.md
│   │   ├── logo.md
│   ├── 00-get-started/
│   │   ├── ...
│   ├── 01-components/
│   │   ├── ...
│   └── 02-examples/
│       └── ...
├── _includes/
│   └── ...
└── _layouts/
    ├── pattern.html
    └── ...

How It Works

This tool is designed to generate a simple and lightweight styleguide for your digital projects.

  1. Create your UI components (patterns), or example pages with HTML and store in src/html.
  2. Add your pattern/page assets to src/assets - CSS architecture follows this SCSS Playbook, but it can be changed to suit your needs.
  3. Make sure your assets are referenced in the HEAD section of the _layouts/pattern.html file.
  4. To appear in the sidebar, each pattern/page must have a corresponding markdown Documentation file in the _docs/ folder.
  5. The Documentation file should contain the location of the pattern styles, the maturity of the pattern, as well as any further usability information or rules for use.

Patterns and Pages are always loaded in an iframe so Styleguide styles will not interfere with your added assets.


Design and Artwork

Source artwork can be stored in the src/design_source folder in either Illustrator or Sketch format.


Development & Deployment

As this styleguide is built with Jekyll, it can be served locally using jekyll serve, and it can be published via Github Pages.

Note: CNAME Files can be removed.


Where Things Live

Design Files

  • src/html/ is used to store your HTML components and example pages. Each pattern.html file must start with Front Matter, this applies the _layouts/pattern.html template to the file, and rederes it correctly.
  • src/assets/ is used to store any JS, SCSS, CSS, Fonts, etc… that are needed to correctly render your patterns.
  • _docs/ is used to store all pattern documentation is it is important to make sure that every pattern added to the src/html/ folder has a corresponding file with the same name inside this documentation file.
  • _layouts/pattern.html is used to generated each pattern and page, ensure your assets are included in the usual HTML way.

Styleguide Files

  • Styleguide styles and scripts are contained in the styleguide/ directory - altering these styles will change the design and function of the styleguide shell.
  • _layouts/pattern.html should be changed if you add any assets to your patterns e.g. an additional css file.
  • _includes/ & _layouts/ associated with the styleguide are stored here - they do not need to be edited unless you are changing the function of the styleguide shell.