前言
通常我們所做的一些頁面,我們可以從設計圖里面看出有一些地方是相同的。例如:頭部,底部,側邊欄等等。如果是制作靜態頁面的同學,對於這些重復的部分只能夠通過復制粘貼到新的頁面來,如果頁面的數量上去了而中途公共的部分出現要修的地方。不過有上10個頁面都用到了這個公共的html
代碼。那修改起來不是很麻煩嗎?
對於后端的同學而言,他們可以通過模版來進行拆分。這樣做可以提高html
代碼的復用性和可維護性。但對於只是對設計圖而制作成靜態頁面的同學而言他們,html
沒有提供像模版的include
這種方法。但又不想使用到后端的模版,那么接下來的我介紹的幾個工具也許可以幫助到你。
gulp-file-include
第一個我要介紹的是一個gulp
的插件,他提供了一個include
的方法讓我們可以想后端模版一樣把公共的部分分離出去。而且提供的include
方法有許多配置項,詳細可以去看看 gulp-file-include。
下面我們寫一個小demo
來快速的了解一下,我們需要先安裝gulp
以及gulp-file-include
。
npm install -g gulp mkdir gulp-file-include && cd gulp-file-include npm install gulp --save-dev npm install gulp-file-include
安裝好之后,來簡單的組織一下文件的目錄:
|-node_modules |-src // 生產環境的 html 存放文件夾 |-include // 公共部分的 html 存放文件夾 |-*.html |-dist // 編輯后的 html 文件 gulpfile.js
在新建的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>
最后回到命令行工具里,執行gulp fileinclude
:
看到編譯完成之后,到dist
目錄一下有一個layout.html
的文件,這就是最后編譯出來的。
好了,上面的一個小實例也明白之后。也許能夠在以后的工作中大大提供生產力,使得自己寫的html
代碼更加具有維護性和可復用性。
前端模版
上面說道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
這個方法,可能會覺得有點大才小用。有興趣的同學可以再去了解一下模版的一些方法。