HTML 代码复用——gulp-file-include

最新推荐文章于 2023-11-21 20:12:59 发布

mrhaoxiaojun

最新推荐文章于 2023-11-21 20:12:59 发布

阅读量1.5k

点赞数

分类专栏： Gulp 文章标签： npm gulp-file-include

Gulp 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

gulp-file-include提供了一个include的方法让我们可以想后端模版一样把公共的部分分离出去。而且提供的include方法有许多配置项，详细可以去看看 gulp-file-include。

安装：npm install gulp-file-include –save-dev

安装好之后，来简单的组织一下文件的目录：

|-node_modules
|-src // 生产环境的 html 存放文件夹
    |-include // 公共部分的 html 存放文件夹
    |-*.html 
|-dist // 编辑后的 html 文件

在新建的gulpfile.js，配置好gulp-file-include：

var gulp = require('gulp');
var fileinclude  = require('gulp-file-include');

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

接着新建两个html文件，分别是头部和底部：

header.html

<h1>这是 header 的内容</h1>

footer.html

<h1>这是 footer 的内容</h1>

最后在新建一个html，把要用到的header和footer给include进来。

layout.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>
    @@include('include/header.html')

    <p> 这是 layout 的内容 </p>

    @@include('include/footer.html')
</body>
</html>

编译完成之后，到dist目录一下有一个layout.html的文件，这就是最后编译出来的。

前端模版ejs

上面说道gulp-file-include简单而且易上手，对于不想使用模版的同学是一个很好的小工具。但是熟悉前端模版的同学来说，我们一样可以使用模版来做到html代码的维护性和可复用性。那么我就用一个我自己比较常用的ejs这个模版来说说一下如何分离那些公共部分的html文件。

把上一个例子的整个文件夹复制到一个新的地方，然后把名字修改为ejs。接着把node_modules文件夹给删除，dist文件夹下的html文件都删除。

用到ejs模版的话，需要把src里面的html文件的后缀名都修改成.ejs。把ejs文件编译成html的工具依旧是使用gulp。只需要安装gulp-ejs就可以了。

npm install gulp --save-dev
npm install gulp-ejs --save-dev

接着就是修改gulpflie.js文件了：

var gulp = require('gulp');
var ejs  = require('gulp-ejs');

gulp.task('ejs', function() {
    gulp.src('src/**.ejs')
        .pipe(ejs())
    .pipe(gulp.dest('dist'));
});

然后是修改layout.ejs文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>
    <%-include include/header  %>

    <p> 这是 layout 的内容 </p>

    <%-include include/footer  %>
</body>
</html>

最后就是在命令行工具里面运行gulp ejs，在到dist目录下看到编译好的layout.html文件。就大功告成了。

其实模版具有许多强大的方法，而上面的例子主要还是演示include这个方法，可能会觉得有点大才小用。有兴趣的同学可以再去了解一下模版的一些方法。

mrhaoxiaojun

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
HTML 代码复用——gulp-file-include

gulp-file-include提供了一个include的方法让我们可以想后端模版一样把公共的部分分离出去。而且提供的include方法有许多配置项，详细可以去看看 gulp-file-include。安装：npm install gulp-file-include –save-dev 安装好之后，来简单的组织一下文件的目录：|-node_modules|-src // 生产环
复制链接

扫一扫