Pug

Pug, formerly known as Jade, is a template engine for Node.js. It is used to generate HTML, XML, and other markup languages. Pug's syntax is simple and clean, making it easy to read and write. Pug uses indentation, rather than braces and semicolons, to define the structure of the HTML. It allows for the creation of reusable templates and includes features such as template inheritance and mixins. Pug also supports variables, loops and conditionals. Additionally, it can be integrated with other Node.js frameworks such as Express.

Pug helps to generate semantic, clean and reusable code, it is one of the most popular template engine for Node.js

NPM downloads

Github stars

Github forks

Number of contributors

Number of contributors 30 days

Number of Contributors

258

Number of days since last commit

698

Top contributors all time

Tj Holowaychuk	994
Forbes Lindesay	462
Timothy Gu	261
TJ Holowaychuk	252
ForbesLindesay	89
Cameron Howey	44
hemanth.hm	25
Andreas Lubbe	21
jser.me	12
Grey	10
Guillermo Rauch	10
Ryunosuke SATO	8
Casey Foster	7
Jeremy Larkin	6
Sean Ho	6
enlore	6
Eldar Gabdullin	5
Jake Luer	5
Jakukyo Friel	5
Joshua Appelman	5

Readme

Pug

Full documentation is at pugjs.org

Pug is a high-performance template engine heavily influenced by Haml
and implemented with JavaScript for Node.js 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.

Professionally supported pug is now available

Packages

Package Name	Version
pug
pug-attrs
pug-code-gen
pug-error
pug-filters
pug-lexer
pug-linker
pug-load
pug-parser
pug-runtime
pug-strip-comments
pug-walk

Rename from "Jade"

This project was formerly known as "Jade". However, it was revealed to us that "Jade" is a registered trademark; as a result, a rename was needed. After some discussion among the maintainers, "Pug" was chosen as the new name for this project. As of version 2, "pug" is the official package name.

If your package or app currently uses jade, don't worry: we have secured permissions to continue to occupy that package name, although all new versions will be released under pug.

Before the renaming, work had already begun on “Jade 2.0.0”. Therefore, the rename to Pug coincided with the major version bump. As a result, upgrading from Jade to Pug will be the same process as upgrading any other package with a major version bump.

The syntax of Pug has several differences, deprecations, and removals compared to its predecessor. These differences are documented in #2305.

The website and documentation for Pug are still being updated. But if you are new to Pug, you should get started with the new syntax and install the Pug package from npm.

Installation

Package

To use Pug in your own JavaScript projects:

$ npm install pug

Command Line

After installing the latest version of Node.js, install with:

$ npm install pug-cli -g

and run with

$ pug --help

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.

Pug transforms the above to:

<!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>

API

For full API, see pugjs.org/api/reference.html

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 downloaded for the browser in standalone form. 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.

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