Slush Molecule
Slush scaffolding to create molecule in Pattern Lab
Getting Started
Install slush-molecule
globally: (May require SUDO or admin rights)
$ npm install -g slush-molecule
Usage
You must run the slush command from the root folder of your Pattern Lab (PL2)
$ slush molecule
You will be prompted for serveral things including the name of your molecule, if you need a javascript file, and if json file created for the molecule. Your answers will dictate which items get scaffolded into Pattern Lab.
Command to see which generators are installed:
$ slush
Uninstall Slush Molecule:
sudo npm uninstall slush-molecule -g
Configuring your Slush Molecule
You can configure filepaths and templates used by adding a slush-molecule-config.json
file in the same place that you run the slush molecule
command from.
The default configuration is included in this project. Your local configuration will override and merge with that file. See below for an explaination of each value:
Getting To Know Slush
Slush is a tool that uses Gulp for project scaffolding.
Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.
To find out more about Slush, check out the documentation.
Contributing
See the CONTRIBUTING Guidelines
Support
If you have any problem or suggestion please open an issue here.
License
Unlicensed
Copyright (c) 2016, Carlos Picart