gulp-html-import,在html中引入外部html文件

1

项目地址:

gulp-html-import

曾经学习PHP的时候,深深觉得include语法非常好用,后接触了ejs,发现里面也有类似的语法,能够方便地引入公共html文件;在学习了vuereact等框架以后,“组件化思想”更是在我脑海根深蒂固,再也无法忍受每个页面重复大量代码的原始方法。但是,在最最普通的静态html开发过程中,我实在懒得用框架,只想用最基本的方式写几个静态页面出来,这时候才想起,没有include语法,每个页面的公共部分都要手动复制粘贴一次,实在不科学……

早上看了张鑫旭老师的文章《JS一般般的网页重构可以使用Node.js做些什么》,深受启发,于是马上蹦起床尝试着把当中内容实现一遍,并尝试着搭配gulp,制作一个简单好用的插件,实现类似PHPinclude语法能够引入静态html文件的功能。

因为喜欢less语法,所以使用了类似less的@import 'xxx.less';作为引入方式。

下面直接粘贴项目readme的内容


gulp-html-import

A gulp plugin which can import .html files into .html files

Usage

First, install gulp-html-import as a devDependency:

npm install gulp-html-import --save-dev

Then add it to the gulpfile.js:

var htmlImport = require('gulp-html-import');

gulp.task('import', function () {
    gulp.src('./demo/index.html')
        .pipe(gulpImport('./demo/components/'))
        .pipe(gulp.dest('dist')); 
})

Example

Here is the files tree:

|
-- demo
|   |
|   -- components
|   |    |
|   |    -- header.html
|   |    |
|   |    -- footer.html
|   |
|   -- index.html
|
-- gulpfile.js

Html files:

<!-- index.html -->

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Gulp-html-import Example</title>
</head>
<body>
    @import "header.html"
    <p>Hello World</p>
    @import "footer.html"
</body>
</html>

In your index.html, you should use

@import "XXX.html"

to import your components.

<!-- header.html -->

<h1>I am the header</h1>
<!-- footer.html -->

<h1>I am the footer</h1>

When you get into the root directory(where your gulpfile.js is) and type

gulp import

you could see a html file in /dist like this:

<!-- /dist/index.html -->

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Gulp-html-import Example</title>
</head>
<body>
    <h1>I am the header</h1>
    <p>Hello World</p>
    <h1>I am the footer</h1>
</body>
</html>

Everything is OK.

API

htmlImport(string)

string

Type: String

The url of your components


MIT

Copyright © 2016 Jrain Lau


如果觉得我的文章对你有用,请随意赞赏

你可能感兴趣的

晓朔一一 · 2017年07月04日

可以引入外部的js文件吗?

+1 回复

MatthewLee · 2016年06月27日

很强大,不过我尝试了一下,输出的时候注释能够带上缩进,但是html代码好像没有带缩进哦~

回复

萱萱 · 2017年03月07日

为什么我按照这个配置来 怎么就是编译不了 html中的impor 这个呢?t

回复

Sweet_KK · 2018年05月11日

代码是复用了,但是如果头部和底部引用了很多图片,css之类的,src该怎么处理,文件层级不同的时候,肯定会出现部分文件找不到src的

回复

载入中...