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

    5.0.0 • Public • Published

    gulp-pug

    NPM version Downloads Build Status Coveralls Status

    Gulp plugin for compiling Pug templates. Enabling you to compile your Pug templates into HTML or JS, with support for template locals, custom Pug filters, AMD wrapping, and others.

    Usage

    const { src, dest } = require('gulp');
    const pug = require('gulp-pug');
    
    exports.views = () => {
      return src('./src/*.pug')
        .pipe(
          pug({
            // Your options in here.
          })
        )
        .pipe(dest('./dist'));
    };

    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

    License

    MIT

    Install

    npm i gulp-pug

    DownloadsWeekly Downloads

    17,508

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    8.76 kB

    Total Files

    6

    Last publish

    Collaborators

    • phated
    • forbeslindesay
    • hemanth
    • demurgos