https://github.com/elldritch/broccoli-pug

Compile or render Pug templates in a Broccoli tree.
https://github.com/elldritch/broccoli-pug

broccoli broccoli-plugin pug

Last synced: about 1 month ago
JSON representation

Compile or render Pug templates in a Broccoli tree.

• Host: GitHub
• URL: https://github.com/elldritch/broccoli-pug
• Owner: elldritch
• Created: 2016-07-01T09:35:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-17T15:35:42.000Z (almost 3 years ago)
• Last Synced: 2024-10-06T17:08:01.292Z (about 1 month ago)
• Topics: broccoli, broccoli-plugin, pug
• Language: CoffeeScript
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# broccoli-pug

`broccoli-pug` compiles or renders `pug` templates.

Because of Broccoli's design, this plugin is unable to resolve relative

imports to files outside of its input nodes. The workaround for this is to move

all relative imports into the input nodes (e.g. using `broccoli-funnel` and then

`broccoli-merge`). Note that imports must be in the same _input node_; it is not

sufficient to simply include imports as a separate input node. You can do this

by combining nodes using `broccoli-merge`.

# Usage

```js

var Pug = require('broccoli-pug');

var html = new Pug([inputNode1, inputNode2], {

  render: true,

  pugOptions: {

    // ...

  }

});

```

## `pug(inputs, options)`

`inputs` is an array of input Broccoli nodes.

`options` is an optional object specifying plugin options.

`options.render` is a boolean. If true, `broccoli-pug` will render templates to

HTML rather than compiling to a JS function.

`options.pugOptions` specifies options for the `pug` compiler. It is passed

directly to the compiler.

# Contributing

I would love if anybody could contribute some tests to this repository. Feel free

to leave PRs, test or otherwise.

# License

Copyright 2016 Lehao Zhang. Released to the general public under the terms of

the ISC license.