https://github.com/sparkbox/downpour

https://github.com/sparkbox/downpour

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sparkbox/downpour
• Owner: sparkbox
• Created: 2017-04-07T19:16:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T16:23:38.000Z (10 months ago)
• Last Synced: 2024-11-10T22:51:53.606Z (about 2 months ago)
• Language: SCSS
• Size: 800 KB
• Stars: 1
• Watchers: 14
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# Downpour

Sparkbox implementation of [drizzle-builder].

## Usage

Downpour exposes the [drizzle-builder] as a function to compile handlebars templates into HTML.

All [drizzle-builder options][drizzle-builder-options] are valid.

Downpour includes a few handlebars helpers by default:

- all [@cloudfour/hbs-helpers][hbs-helpers]

- [ifProd][sbx-ifprod-helper]

- [is][assemble]

- [isn't][assemble]

- [split][assemble]

To add additional helpers create a `helpers` key in the options object like so:

``` javascript

import downpour from '@sparkbox/downpour';

import { myHelperFunc } from 'my-helper-package';

const opts = {

  helpers: {

    myHelper: myHelperFunc,

  },

};

downpour(opts, cb);

```

## Publishing to NPM

See [contributing] docs.

[assemble]: https://github.com/helpers/handlebars-helpers

[contributing]: ./CONTRIBUTING.md

[drizzle-builder-options]: https://github.com/cloudfour/drizzle-builder#options

[drizzle-builder]: https://www.npmjs.com/package/drizzle-builder

[hbs-helpers]: https://github.com/cloudfour/core-hbs-helpers/tree/master/lib

[sbx-ifprod-helper]: https://github.com/sparkbox/ifProd-helper

[semantic-versioning]: https://docs.npmjs.com/about-semantic-versioning