Skip to content

polvo/polvo-html

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Polvo HTML

With this plugin, Polvo can handle HTML source files.

Stories in Ready

Build Status Coverage Status

Dependency Status NPM version

Install

You won't need to install it since it comes built in in Polvo.

Enjoy.

Instructions

Just put your .html or .htm files in your input dirs and it will be ready for use.

Templates are compiled to strict CJS modules, to require them just use the well known CJS pattern, more info here.

The same resolution algorithm presented in NodeJS will be used.

Example

template = require './your/html/template'

dom = template()
console.log dom
# append it to your document, i.e:
# $('body').append dom

Partials

There's a built in support for partials in your html files.

Every file starting with _ won't be compiled alone. Instead, if some other file that doesn't start with _ imports it, it will be compiled within it.

The import tag follows the basic SSI specification.

To include a partial in your html, just:

  1. Name your patial accordingly so it starts with _
  2. Include it in any of your html files by using the syntax
<!--#include file="_partial-name-here" -->

Partials are referenced relatively.