Skip to content
This repository has been archived by the owner on Mar 30, 2021. It is now read-only.

SFDigitalServices/sfgov-pattern-lab

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 187 commits ahead, 1 commit behind chapter-three:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

SFGOV Pattern Library.

This project is based off the PHP Twig version of Pattern Lab.

Dependencies

  • php-cli (If php --version returns version info, then this is already installed)
  • NodeJS
  • Composer

Installation

  1. cd pattern-lab

  2. composer install

    Answer the prompts as follows:

    • The path ./public/ already exists. Merge or replace with the contents of pattern-lab/styleguidekit-assets-default package? M
    • Update the config option styleguideKitPath? n
  3. cd ../

  4. php pattern-lab/core/console --generate

  5. npm install

Getting Started

  1. Run gulp. (You might need to re-install with npm install gulp -g)

  2. php pattern-lab/core/console --server --watch

Other Commands

Generating a public instance: $ php pattern-lab/core/console --generate

Viewing a full list of commands: $ php pattern-lab/core/console --help

Documentation

  • Edit the document <head> in pattern-lab/source/_meta/00-head.twig.
  • Edit pattern styles and markup in pattern-lab/source/_patterns.
  • Add or edit Markdown files to pattern-lab/source/_patterns to document the usage and context of each pattern.
  • Add any images to pattern-lab/source/images.

All changes in /source/ automatically compile to /public.

About

SFGOV Pattern Lab

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 43.2%
  • JavaScript 24.3%
  • HTML 20.8%
  • PHP 11.7%