grunt-phtml
v3.0.0
Published
Use pHTML with Grunt
Downloads
3
Maintainers
Readme
Grunt pHTML
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: ''
}
}
}