gulp实现公共html代码复用

用户1174387

发布于 2018-01-17 12:08:02

2.2K0

发布于 2018-01-17 12:08:02

文章被收录于专栏：web开发

在开发网站的时候，尤其是类似于官网这样的项目，顶部都会有一个导航栏，底部会有一些其他信息，而这两个部分在每一个页面都是有的。我们不可能在每个html页面都写一遍，这样也不便后期维护等操作，所以可以把顶部导航和底部这两块的html代码单独写在两个html文件里：header.html和footer.html，然后在每个html文件只需要在适当的位置引入公共部分的代码即可。gulp有一个插件gulp-file-include即可实现该操作，gulp编译完成之后，便可在每个html文件里自动加上公共部分的代码。现写一个简单的小demo如下：

1、新建一个项目demo，我这里取名为：gulp

demo目录如下

2、在gulp目录下安装gulp插件

　　1、执行：gulp init 命令，一直回车，然后生成一个package.json文件

　　2、安装gulp：npm install gulp --save-dev

　　3、安装gulp-file-include：npm install gulp-file-include --save-dev

3、在src/include目录下新建三个html文件

　　这里的文件便是公共的html部分，是要在每个html页面被引入的。

3.1、meta.html:

<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,Chrome=1" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>测试文件引入</title>
<meta name="keywords" content="aa,bb,cc,dd,ee,ff">
<meta name="description" content="1234567890">
<link rel="icon" sizes="any" mask="" href="" />
<link rel="stylesheet" type="text/css" href="/dist/css/common.css" />
<meta name="format-detection " content="telephone=no">

3.2、header.html

<div>
    <button><a href="/index.html">首页</a></button>
    <button><a href="/trade-news.html">行业新闻</a></button>
    <button><a href="/product/product.html">公司产品</a></button>
    <button><a href="/contact.html">联系我们</a></button>
</div>

3.3、footer.html

<div>这是footer部分</div>

4、在pages目录下新建几个html页面，在每个页面的适当位置引入include目录下的html文件

注意：@@include后面填写的是相对路径

4.1、src/pages/index.html

<!DOCTYPE html>
<html lang="en">
<head>
    @@include('../include/meta.html')

</head>
<body>
@@include('../include/header.html')
<div>首页</div>
@@include('../include/footer.html')
</body>
</html>

4.2、src/pages/product/product.html

<!DOCTYPE html>
<html lang="en">
<head>
    @@include('../../include/meta.html')
</head>
<body>
@@include('../../include/header.html')
<div>公司产品页</div>
@@include('../../include/footer.html')
</body>
</html>

其他就省略

5、gulpfile.js文件

/**
 * Created by libo on 2017/12/21.
 */
var gulp = require('gulp');
var fileinclude = require('gulp-file-include');

gulp.task('fileinclude', function () {
    gulp.src('src/pages/**/*.html')
        .pipe(fileinclude({
            prefix: '@@',
            basepath: '@file'
        }))
        .pipe(gulp.dest('dist'));
});