npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

html-include

v0.0.1

Published

Process .html files as ejs templates from the document_root

Downloads

5

Readme

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