By default, Nucleus will look for a config.nucleus.json in the current directory. If none is given, default parameters will be used. Also, command line arguments have a greater priority than configuration values.
To easily get your style guide set up, use the step-by-step configuration generator:
nucleus init
The configuration file that shall be used.
Lets you overwrite the title of the style guide.
Target folder to build the style guide to.
To preview the components, you need to specify the path (URI) to your CSS file. You may also pass multiple paths as array.
If you want customize the generated layout you can copy the [default theme](https://github.com/holidaypirates/nucleus/tree/master/assets/views) and customize it.
Lets you override the default image placeholder service. The value will be used in a template literal, and can accept the width, and height parameters.
For easier visual regression testing, you may disable the generation of randomized lipsum texts and image placeholders. With this option enabled, you will always get the same (boring) placeholders.
To defines the vebosity level of the console output. For silent output set 0, for debug mode set 3.
Path to your scss files that nuceleus use for generating source
To add your javascipt, you need to specify the path (URI) to your Javascript file. You may also pass multiple paths as array.
If you use a CSS namespace class around your style, it will appear on the parent node preview.