@fatchan/gulp-pug
TypeScript icon, indicating that this package has built-in type declarations

4.0.1 • Public • Published

gulp-pug Build Status Dependencies Downloads

Gulp plugin for compiling Pug templates

This Gulp plugin enables you to compile your Pug templates into HTML or JS, with support for template locals, custom Pug filters, AMD wrapping, and others. Here is a simple example using gulp-pug:

var pug = require('gulp-pug');

gulp.task('views', function buildHTML() {
  return gulp.src('views/*.pug')
  .pipe(pug({
    // Your options in here.
  }))
});

API

pug([opts])

  • opts (Object): Any options from Pug's API in addition to pug's own options.
  • opts.locals (Object): Locals to compile the Pug with. You can also provide locals through the data field of the file object, e.g. with gulp-data. They will be merged with opts.locals.
  • opts.data (Object): Same as opts.locals.
  • opts.client (Boolean): Compile Pug to JavaScript code.
  • opts.pug: A custom instance of Pug for gulp-pug to use.
  • opts.verbose: display name of file from stream that is being compiled.

To change opts.filename use gulp-rename before gulp-pug.

Returns a stream that compiles Vinyl files as Pug.

Also See

Thanks

LICENSE

MIT © Jamen Marzonie

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
4.0.13latest

Version History

VersionDownloads (Last 7 Days)Published
4.0.13

Package Sidebar

Install

npm i @fatchan/gulp-pug

Weekly Downloads

3

Version

4.0.1

License

MIT

Unpacked Size

8.01 kB

Total Files

6

Last publish

Collaborators

  • fatchan