Home > Article > Web Front-end > Detailed introduction to HTML code reuse practices

Detailed introduction to HTML code reuse practices

黄舟Original: 2017-05-27 14:30:232194browse

Preface

Usually for some pages we make, we can see from the design drawings that there are some similarities. For example: header, bottom, sidebar, etc. If you are a student who makes static pages, you can only copy and paste these repeated parts to a new page. If the number of pages increases and there are areas that need to be repaired in the common parts. However, more than 10 pages use this public html code. Wouldn't it be troublesome to modify it?

For back-end students, they can split it through templates. Doing so can improve the reusability and maintainability of html code. But for students who just make static pages from design drawings, html does not provide a method like template include. But you don’t want to use back-end templates, then the following tools I will introduce may be able to help you.

gulp-file-include

The first thing I want to introduce is a gulp plug-in, which provides a include method to We can separate the public parts just like the backend template. And the include method provided has many configuration items. For details, you can check out gulp-file-include.

Let’s write a small demo to quickly understand. We need to install gulp and gulp-file-include first.

npm install -g gulp
mkdir gulp-file-include && cd gulp-file-include
npm install  gulp --save-dev
npm install gulp-file-include

After installation, let’s simply organize the file directory:

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

In the newly created gulpfile.js, configure gulp-file-include :

var gulp = require(&#39;gulp&#39;);var fileinclude  = require(&#39;gulp-file-include&#39;);

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

Then create two new html files, namely the header and the bottom:

header.html

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

footer.html

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

Finally create a new html and add the header and footer## to be used #Giveincludecome in.

layout.html

<!DOCTYPE html><html lang="en"><head>    <meta charset="UTF-8">    <title>Document</title></head><body>
    @@include(&#39;include/header.html&#39;)    <p> 这是 layout 的内容 </p>

    @@include(&#39;include/footer.html&#39;)</body></html>

Finally go back to the command line tool and execute

gulp fileinclude:

See that the compilation is completed After that, go to the

dist directory and there will be a layout.html file, which is what was finally compiled.

Okay, after understanding the above small example. It may be able to greatly improve productivity in future work, making the

html code you write more maintainable and reusable.

Front-end template

As mentioned above

gulp-file-include is simple and easy to use. It is a good small tool for students who do not want to use templates. But for students who are familiar with front-end templates, we can also use templates to achieve html code maintainability and reusability. Then I will use a ejs template that I commonly use to talk about how to separate those public parts of the html files.

Copy the entire folder of the previous example to a new location, and then change the name to

ejs. Then delete the node_modules folder and delete all the html files under the dist folder.

If you use the

ejs template, you need to change the suffix names of the html files in src to .ejs. The tool to compile ejs files into html still uses gulp. Just install gulp-ejs.

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

The next step is to modify the

gulpflie.js file:

var gulp = require(&#39;gulp&#39;);var ejs  = require(&#39;gulp-ejs&#39;);

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

Then modify the

layout.ejs file:

<!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>

The last step is to run

gulp ejs in the command line tool, and see the compiled layout.html file in the dist directory. And you're done.

In fact, templates have many powerful methods, and the above example mainly demonstrates the

include method, which may seem a bit big but of little use. Interested students can learn more about some methods of templates.

The above is the detailed content of Detailed introduction to HTML code reuse practices. For more information, please follow other related articles on the PHP Chinese website!

Statement：

The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Previous article：A detailed introduction to form components in HTMLNext article：A detailed introduction to form components in HTML

See more

Detailed introduction to HTML code reuse practices

Preface

gulp-file-include

Related articles