gulp-html-ssi
v0.0.92
Published
Gulp plugin for building HTML files into each other. Made for a workflow involving responsive unit testing.
Downloads
28
Readme
gulp-html-ssi
gulp-html-ssi plugin for gulp
Introduction
gulp-html-ssi allows you to compile your html files with includes.
gulp-html-ssi looks through your files for special html comments that it will use to parse them and do the include correctly.
Usage
Install
npm install --save-dev gulp-html-ssiSample gulpfile.js
Then, add it to your gulpfile.js:
var gulp = require('gulp'),
includer = require('gulp-html-ssi');
gulp.task('htmlSSI', function() {
gulp.src('./source/**/*.html')
.pipe(includer())
.pipe(gulp.dest('./build/'));
});
gulp.task('default', ['htmlSSI']);
gulp.task('watch', function() {
gulp.watch(['./source/**/*.html'], function(event) {
gulp.start('default');
});
});API
File naming convention
gulp-html-ssi requires files follow a particular naming convention.
Files that you want to include in other files begin with _.
Files that you want to use to build the resulting static pages can be named however you want, as long as they don't begin with _.
Include
This is the simplest use case. Simply put the following html comment
<!--#include file="_filename" -->
or
<!--#include virtual="_filename" -->
Example
file1.html
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<!--#include file="__file2.html" -->
</body>
</html>__file2.html
hello worldResults
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
hello world
</body>
</html>