Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 2.67 KB

README.md

File metadata and controls

90 lines (64 loc) · 2.67 KB

license

Demo StarterKit for Thymol

The Demo StarterKit for Thymol is meant to show off some of the capabilities of developing Thmyol/Thymeleaf-based projects in Pattern Lab.

Requirements

  • The node version of Pattern Lab (this StarterKit does not work with the PHP version)
  • Either the Gulp Edition or Grunt Edition for Pattern Lab

Setting up the PatternEngine

The Demo StarterKit for Thmyol requires the following PatternEngine:

  • headissue/patternengine-node-thmyol: GitHub, npm

Configuring Pattern Lab to use Thymol templates

Editions are shipped with a default configuration for Mustache. Therefor, the following changes must be made to patternlab-config.json:

  • Change

    "patternExtension": "mustache"

    to

    "patternExtension": "html"

  • For faster development, enable Incremental Builds:

    "cleanPublic": true

Install

Modify package.json to add the Thymol engine and this StarterKit to the dependencies section:

"dependencies": {
  "patternengine-node-thymol": "^0.1.1",
  "starterkit-thymol-demo": "^1.0.0"
  ...
}

and run

npm install

to automatically install the Thymol PatternEngine and the StarterKit.

Manual installation

Then this StarterKit can be installed via one of the following commands:

  • Gulp edition

     gulp patternlab:loadstarterkit --kit=starterkit-thymol-demo --clean=true

  • Grunt edition

    See Known issues below!

     grunt patternlab:loadstarterkit --kit=starterkit-thymol-demo --clean=true

Known issues

Grunt edition: As of 23rd March, 2017, no files are copied. See Loading starterkit does not copy files for details. As a workaround:

  1. Delete everything under source
  2. Download the latest release of this StarterKit on GitHub and copy the contents of dist into the source folder

Edit Files

After installation the files for this StarterKit can be found in source/.

Acknowledgements

This repository is based on the Demo StarterKit for Mustache by Brad Frost and Dave Olsen