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

template-html

v0.3.2

Published

Generate static HTML files from templates and content files

Downloads

1,296

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

grit96grit96

Keywords

Readme

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.