node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »

template-html

template-html

NPM Version Build Status Dependency Status

Generate static HTML files from templates and content files. gulp-template-html is a Gulp plugin for this with example usage.

Installation

$ npm install -g template-html

Help

Usage: template-html content.html -t template.html [options]
 
-h|--help      display this help message
-v|--version   display the version number
-o|--output    directory to output processed HTML
-t|--template  template file to use
--tag          keyword to use be used in HTML placeholder define and build comments
--build-tag    keyword to use be used in HTML placeholder build comments (overrides --tag)
--define-tag   keyword to use be used in HTML placeholder define comments (overrides --tag)
--preserve-tree  output files will keep the same directory structure as the source files

Sample usage

For the most basic use case of this plugin, create a template file with placeholders and a file containing the content that should replace the placeholders in the template.

For more details and more complex examples take a look at the examples directory.

template.html:

<!DOCTYPE html>
 
<html lang="en">
<head>
<meta charset="utf-8">
<title><!-- build:title --></title>
</head>
<body>
  <div id="content"><!-- build:content --></div>
</body>
</html>

content.html:

<!-- build:title -->Lorem ipsum<!-- /build:title -->
<!-- build:content -->
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
<!-- /build:content -->

Documentation

Templator(options)

Creates a new Templator instance.

Params

  • Object options: An object containing the following fields:
  • templateFile (String): Path to template file to use.
  • tag (String): Keyword to use be used in HTML placeholder comments.

processFile(contentFile)

Run the contents of an HTML file through the Templator

Params

  • String contentFile: Path to HTML file to be processed

Return

  • String The processed HTML

processContent(content)

Generate HTML from template file and content file

Params

  • String content: HTML content to be used in template

Return

  • String The processed HTML

How to contribute

  1. File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
  2. Fork the project in your account and create a new branch: your-great-feature.
  3. Commit your changes in that branch.
  4. Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.