Class: KssBuilderBaseNunjucks

kss/builder/base/nunjucks~KssBuilderBaseNunjucks()

new KssBuilderBaseNunjucks()

Create a KssBuilderBaseNunjucks object.

const KssBuilderBaseNunjucks = require('kss/builder/base/nunjucks');
const builder = new KssBuilderBaseNunjucks();
Source:

Methods

build(styleGuide) → {Promise}

Build the HTML files of the style guide given a KssStyleGuide object.

Parameters:
Name Type Description
styleGuide KssStyleGuide

The KSS style guide in object format.
Source:
Returns:

A Promise object.

Type
Promise

prepare(styleGuide) → {Promise.<KssStyleGuide>}

Allow the builder to preform pre-build tasks or modify the KssStyleGuide object.

The method can be set by any KssBuilderBase sub-class to do any custom tasks after the KssStyleGuide object is created and before the HTML style guide is built.

Parameters:
Name Type Description
styleGuide KssStyleGuide

The KSS style guide in object format.
Source:
Returns:

A Promise object resolving to styleGuide.

Type
Promise.<KssStyleGuide>