# gulp-x-includer
**Repository Path**: pandao/gulp-x-includer
## Basic Information
- **Project Name**: gulp-x-includer
- **Description**: Gulp plugin for include js/css/html... any file.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2015-10-18
- **Last Updated**: 2021-06-20
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# gulp-x-includer
Gulp plugin for include js/css/html... any file.
### Install
```shell
$ npm install gulp-x-includer --save-dev
```
### Syntax
Default supported 4 comment syntax.
```
'' or ""
// include "path/to/xxx.js"
/* include "path/to/xxx.css" */
# include "./include/test.txt"
```
HTML :
```html
```
JavaScript :
```javascript
// include "path/to/xxx.js"
```
CSS :
```css
/* include "path/to/xxx.css" */
```
Other file (e.g. markdown .md, configure .conf, .ini ...) :
```markdown
# include "./include/test.txt"
```
### Examples
`test.html` :
```html
Test HTML Document
TEST
TEST
```
`Gulpfile.js` :
```javascript
var gulp = require('gulp');
var includer = require("gulp-x-includer");
gulp.task("include", function(){
gulp.src(["./*.html", "./*.css", "./*.js"])
.pipe(includer())
.pipe(gulp.dest("./dist"));
});
```
Build :
```shell
$ gulp include
```
### Options
```javascript
{
debug : true | false, // print file includes for console.log(), default false.
debugOptions : true | false, // print options object for console.log(), default false.
regexs : {}, // define you include regex
transform : function(content) {} // transform include file content
}
```
### Changes
[Change logs](https://github.com/pandao/gulp-x-includer/blob/master/CHANGE.md)
### License
The [MIT](https://github.com/pandao/gulp-x-includer/blob/master/LICENSE) License.
Copyright (c) 2015 Pandao