Nihilist Postmodern Mistake
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

jaide

2.0.0-alpha7 • Public • Published

Pug - Node Template Engine

Pug has been recently re-named from Jade. The website and documentation are still being updated, but if you're new to pug, you should install the pug package on npm.

Full documentation is at jade-lang.com

Pug is a high performance template engine heavily influenced by Haml and implemented with JavaScript for node and browsers. For bug reports, feature requests and questions, open an issue. For discussion join the chat room.

You can test drive Pug online here.

Build Status Coverage Status Dependency Status devDependencies Status NPM version Join Gitter Chat

Installation

via npm:

$ npm install pug

Syntax

Pug is a clean, whitespace sensitive syntax for writing html. Here is a simple example:

doctype html
html(lang="en")
  head
    title= pageTitle
    script(type='text/javascript').
      if (foo) bar(1 + 5)
  body
    h1 Pug - node template engine
    #container.col
      if youAreUsingPug
        p You are amazing
      else
        p Get on it!
      p.
        Pug is a terse and simple templating language with a
        strong focus on performance and powerful features.

becomes

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Pug</title>
    <script type="text/javascript">
      if (foo) bar(1 + 5)
    </script> 
  </head>
  <body>
    <h1>Pug - node template engine</h1>
    <div id="container" class="col">
      <p>You are amazing</p>
      <p>Pug is a terse and simple templating language with a strong focus on performance and powerful features.</p>
    </div>
  </body>
</html>

The official Pug tutorial is a great place to start.

API

For full API, see jade-lang.com/api

var pug = require('pug');
 
// compile
var fn = pug.compile('string of pug', options);
var html = fn(locals);
 
// render
var html = pug.render('string of pug', merge(options, locals));
 
// renderFile
var html = pug.renderFile('filename.pug', merge(options, locals));

Options

  • filename Used in exceptions, and required when using includes
  • compileDebug When false no debug instrumentation is compiled
  • pretty Add pretty-indentation whitespace to output (false by default)

Browser Support

The latest version of pug can be download for the browser in standalone form from here. It only supports the very latest browsers though, and is a large file. It is recommended that you pre-compile your pug templates to JavaScript and then just use the runtime.js library on the client.

To compile a template for use on the client using the command line, do:

$ pug --client --no-debug filename.pug

which will produce filename.js containing the compiled template.

Command Line

After installing the latest version of node, install with:

$ npm install pug-cli -g

and run with

$ pug --help

Additional Resources

Tutorials:

Implementations in other languages:

Other:

License

MIT

Keywords

none

install

npm i jaide

Downloadsweekly downloads

3

version

2.0.0-alpha7

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar