This project is discontinued.
A library to include HTML and Markdown partials inside a web page, useful for layout templates with Handlebars and read Markdown articles without complex works.
Installation
To download the last release you can use Bower:
bower install --save include-js
You can also download version 1.2.2 from github.
Features
- Use
<include>tag to include html partials on the page - It supports Handlebars and can handle JSON strings
- You can wrap JSON strings inside
<include> { "message" : "hello" } </include>tag to send data to Handlebars - You can link a JSON file to
<include>withdata-json-srcattribute - It supports Marked to include markdown files
- You can include
.htmlor.mdfiles, IncludeJS will know what to do
===
Base usage example:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IncludeJS test page</title>
<meta name="author" content="Vittorio Vittori">
<meta name="description" content="IncludeJS is a library to include HTML partials, useful for static templates">
<script src="test/vendor/handlebars-v1.3.0.js"></script>
<script src="test/vendor/marked.js"></script>
<script src="../include.js"></script>
<!--[if lt IE 9]>
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<include
src="template/header.html"
data-json-src="data/menu.json">
</include>
<section>
<include src="template/content.md"></include>
</section>
<include src="template/footer.html">
{
"author" : "Vittorio Vittori",
"url" : "http://vit.to"
}
</include>
<script type="text/javascript">
Include.onLoad = function() {
console.log("Hello! Everything is loaded succesfully and JS can be executed with happyness!");
};
</script>
</body>
</html>To test it on Mac OSX run this command in the root folder:
npm install && ./node_modules/.bin/bower install && php -S localhost:8000 -t ./ && open http://localhost:8000/test/index.html
Then, in the browser go to:
http://localhost:8000/test/index.html