❤
npm
Sign UpSign In

html-include

0.0.1 • Public • Published

html-include

Process .html files as ejs templates from the document_root

usage

Create a html-include handler for a folder full of .html files:

var htmlinclude = require('html-include');
 
var app = express();
 
var includes = htmlinclude({
 
    // the root folder with our .html files
    document_root:__dirname + '/www',
 
    // allow '/contact' = '/contact.html'
    allowdirs:true,
})
 
// this registers the .html -> ejs template handler
includes.setup(app);
 
// we can fill in page specific template variables here
includes.on('page', function(filepath, vars){
    if(filepath.match(/\/contact/){
        vars.title = 'Contact Page';
    }
})
 
// your application routes
app.get('/my/app/etc', function(req, res, next){
 
})
 
// mount the actual file server
app.use(includes.serve)

Inside each .html file we can use the 'include' function for things like headers and footers:

index.html

<% include header.html %>
 
This is the index page
 
<% include footer.html %>

header.html

<html>
    <head>
        <title><%= pagetitle %></title>
    </head>
<body>

footer.html

</body>
</html>

page events

each time a template is rendered - the 'page' event is fired with the originating request and a vars object to be populated:

includes.on('page', function(filepath, vars){
    if(filepath.match(/\/contact/){
        vars.title = 'Contact Page';
    }
    else if(filepath.match(/\/shop/){
        vars.title = 'Shop Page';
    }
})

render

you can call the render method from elsewhere in your logic:

app.get('/mypath', function(req, res, next){
    if(req.params.flag){
        includes.render('/myflag.html', {
            flag:true
        })
    }
    else{
        next();
    }
})

license

MIT

Readme

Keywords

Package Sidebar

Install

npm i html-include

Repository

github.com/binocarlos/html-include

Homepage

github.com/binocarlos/html-include

Weekly Downloads

2

Version

0.0.1

License

MIT

Last publish

Collaborators

  • binocarlos
Try on RunKit
Report malware