Skip to content
Use pHTML with Grunt
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tasks
test
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
Gruntfile.js
README.md
package.json

README.md

Grunt pHTML pHTML

NPM Version Build Status Support Chat

Grunt pHTML lets you use pHTML with Grunt.

Install

Add Grunt pHTML to your project:

npm install grunt-phtml --save-dev

Usage

Use Grunt pHTML in your Gruntfile:

grunt.loadNpmTasks('grunt-phtml')

grunt.initConfig({
  phtml: {
    options: {
      /* pHTML Plugins */
      plugins: [], // Array | Plugin | Function

      /* pHTML Plugins */
      processOptions: {} // Object
    },
    dist: {
      /* One or more files processed as one destination */
      src: 'src/*.html',
      dest: 'build/index.html'

      /* One or more files processed as multiple destinations */
      /* files: [{
        expand: true,
        src: 'src/*.html',
        dest: 'dest'
      }] */
    }
  }
})

Options

options.plugins

The plugins array determines which pHTML plugins are applied.

{
  phtml: {
    options: {
      plugins: require('@phtml/image-alt')
    }
  }
}
{
  phtml: {
    options: {
      plugins: [
        require('@phtml/image-alt'),
        require('@phtml/image-size')({ intrinsicsize: 'intrinsic' })
      ]
    }
  }
}

processOptions

The processOptions property determines which pHTML custom settings are applied.

{
  phtml: {
    options: {
      processOptions: {
        voidElements: ['path', 'source', 'use']
      }
    }
  }
}

options.separator

The separator string determines how value multiple sources are joined together. By default, sources are combined with a newline (\n).

{
  phtml: {
    options: {
      separator: ''
    }
  }
}
You can’t perform that action at this time.