Git Product home page Git Product logo

gulp-html-js-template's Introduction

HTML templates to JS

This gulp plugin converts a html file with templates into a js file containing an object with all templates as strings.

Writing template inside a structured HTML file is much more practical than in a one line javascript string. Therefore this plugin turns a HTML file with templates into a js object. You can use whatever template language you like it simply turns the html nodes into a js string. It will take the html id attribute as the key and its innerHTML as the value.

Usage

An example usage with gulp:

var gulp        = require('gulp');
var html2js = require('gulp-html-js-template');

gulp.task('template', function() {
	return gulp.src( 'my/template.html' )
	.pipe( html2js() )
	.pipe( gulp.dest( 'output' ) );
});

Example

This example shows how this plugin turn html into a js object.

HTML Source :

<div id="templates">

	<div id="my-example-template">
		<p>A {{ handlebar }} example.</p>
	</div>
	
</div>

The generated output :

var templates = {"my-example-template":"<p>A {{ handlebar }} example.</p>"}

Custom JS Code

If you like to adjust the content of the generated js file you can define that inside the html file.

HTML Source including custom js :

<script id="file-content" type="text/javascript">
// Here I can program whatever I want.
var myProject = {};
myProject.templates = <%= templates %>;
</script>

<div id="templates">

	<div id="my-example-template">
		<p>A {{ handlebar }} example.</p>
	</div>
	
</div>

The generated output :

// Here I can program whatever I want.
var myProject = {};
myProject.templates = {"my-example-template":"<p>A {{ handlebar }} example.</p>"};

Options

{ ext:'js' } The extension of the generated output file. If you like to generate something different that a js file. For example for Coffescript or Typescript.

gulp-html-js-template's People

Contributors

legoheld avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.