Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
etylsarin committed Jun 23, 2016
1 parent afe9fbe commit be461c1
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@

> Server Side Includes parser plugin for [gulp](https://github.com/wearefractal/gulp)
Works with both include types

```html
<!--#include file="includes/navigation.html" -->
```

```html
<!--#include virtual="../templates/navigation.html" -->
```

## Usage

First, install `gulp-ssi` as a development dependency:
Expand All @@ -17,10 +27,20 @@ Then, add it to your `gulpfile.js`:
var ssi = require("gulp-ssi");

gulp.src("./src/*.ext")
.pipe(ssi())
.pipe(ssi({
root: '/my-pages'
}))
.pipe(gulp.dest("./dist"));
```

## Options

### root (optional)
Type: `String`
Default: File directory

Set the location where the linked files are hosted.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)
Expand Down

0 comments on commit be461c1

Please sign in to comment.