danielbayerlein / wintersmith-pattern-library

💅 A wintersmith project template for creating and managing your front-end pattern library / style guide.

wintersmith-pattern-library

Flexible and minimalistic - wintersmith-pattern-library is a front-end pattern library / style guide built on top of wintersmith.

Features

• Create and manage your front-end pattern library / style guide
• Generate static pages
• Easy configuration and handling
• Use internal and external dependencies

Installation

1. Download or clone the repository:

git clone https://github.com/danielbayerlein/wintersmith-pattern-library.git

2. Install the dependencies:

npm install

Usage

Build

Create the static files with:

npm run build

Preview

Start a local web server running at http://localhost:8080/ with:

npm run preview

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Copyright

Copyright (c) 2016-present Daniel Bayerlein, Chris Helgert. See LICENSE for details.