include-tag v1.1.0

Include Tag

How to deal with the common header and footer in your batch of html files? It used to be a question, but use the <include> tag in html file, it wasn't a question anymore.

How to use

Develop

Use includeTag.browser.js for develop. DEMO

index.html

<include src="header.html" text="THIS IS THE TITLE"></include>
<div>Content</div>
<include src="footer.html"></include>
<script type="text/javascript" src="../dist/includeTag.browser.js"></script>

header.html

<header>
    <h1>{{text}}</h1>
    <include src="./menu/menu.html"></include>
</header>

Production

I recommend you to use gulp-include-tag to compile html files.

However, you can write your own build script to do it too.

var fs = require('fs');
var includeTag = require('../dist/includeTag');

var html = fs.readFileSync(__dirname + '/index.html').toString();

// Do it!
html = includeTag(__dirname, html);
// Remove includeTag.browser.js reference.
html = html.replace(/<script.*?includeTag.browser.js.*?<\/script>/gi, '');

fs.writeFileSync('demo/build.html', html, {flags: 'w+'});

Run it, And you would got a compiled html file like this.

build.html

<header>
	<h1>THIS IS THE TITLE</h1>
    <ul>
	    <li>Home</li>
	    <li>Article</li>
	    <li>About</li>
	</ul>
</header>
<div>Content</div>
<footer>Footer</footer>

All done, enjoy it dude.

Why <include> tag

It is the most natural thing in html file, so, why not?

License

MIT ? 威老