https://github.com/frankfang/gulp-html-extend

Extend your html files
https://github.com/frankfang/gulp-html-extend

Last synced: 17 days ago
JSON representation

Extend your html files

• Host: GitHub
• URL: https://github.com/frankfang/gulp-html-extend
• Owner: FrankFang
• Created: 2014-07-28T08:28:17.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-04-24T12:37:50.000Z (over 8 years ago)
• Last Synced: 2024-09-19T03:24:14.144Z (about 2 months ago)
• Language: JavaScript
• Size: 82 KB
• Stars: 66
• Watchers: 7
• Forks: 8
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gulp-html-extend [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]

## Make it easy to extend, include and replace your html files

master.html

```html

    

    

```

content.html

```html

    my content

    my footer

```

output

```html

    my content

    my footer

```

## Features

* Nested extending

* Nested including

## Install

```sh

$ npm install --save-dev gulp-html-extend

```

## Syntax

_P.S. [=] means the `=` sign is optional._

**@@master [=] path [jsonString]**

e.g. ``

**@@placeholder [=] blockName**

e.g. ``

**@@include [=] path [jsonString]**

e.g. ``

**@@var [=] variableName**

e.g. ``

**@@block [=] blockName**

e.g. ``

**@@close**

You must add `` at the end of every block

## Usage

```js

var gulp = require('gulp')

var extender = require('gulp-html-extend')

gulp.task('extend', function () {

    gulp.src('./*.html')

        .pipe(extender({annotations:true,verbose:false})) // default options

        .pipe(gulp.dest('./output'))

})

gulp.task('watch', function () {

    gulp.watch(['./*.html'], ['extend'])

})

...

```

## Options

**annotations** [bool]

Make it `false` if you dont want `` in output files.

**verbose** [bool]

Show extra info in the console.

**root** [string (dir path)]

Enable absolute paths which start with `/`.

## Changelog

* 1.2.0 Supoort multiply-lines json 

* 1.1.6 variable default value ``@var foo "defaultValue"``

* 1.1.4 add testing for only includings case.

* 1.1.3 absolute path bug fix [#7](https://github.com/FrankFang/gulp-html-extend/issues/7)

* 1.1.2 cwd bug fix [#6](https://github.com/FrankFang/gulp-html-extend/issues/6)

* 1.1.0 Support absolute path `{root: "path/relative/to/cwd"}`

* 1.0.0 No much changes

* 0.5.0

    * `@@var` support for `@@include`

    * `=` is optional

* 0.4.1 `@@var` bugs fixed

* 0.4.0 `@@var` support for `@@master`

* 0.3.2 Fix bugs of testing

* 0.3.1 Add the verbose option `{verbose: true}`

* 0.3.0 You can include another file in an included file (nested including).

* 0.2.0 Annotations can be disabled via an option `{annotations:false}`

* 0.1.3 Add including annotations.

* 0.1.2 Include path bug fixed.

* 0.1.0 Add `@@include = foo.html` support

## License

MIT © [Frank Fang](http://frankfang.com)

[npm-url]: https://npmjs.org/package/gulp-html-extend

[npm-image]: https://badge.fury.io/js/gulp-html-extend.svg

[travis-url]: https://travis-ci.org/FrankFang/gulp-html-extend

[travis-image]: https://travis-ci.org/FrankFang/gulp-html-extend.svg?branch=master

[coveralls-url]: https://coveralls.io/r/FrankFang/gulp-html-extend

[coveralls-image]: https://coveralls.io/repos/FrankFang/gulp-html-extend/badge.png

[depstat-url]: https://david-dm.org/FrankFang/gulp-html-extend

[depstat-image]: https://david-dm.org/FrankFang/gulp-html-extend.svg