Full documentation is at pugjs.org
You can test drive Pug online here.
This project was formerly known as "Jade." However, it has been revealed to us that "Jade" is a registered trademark, and as a result a rename is needed. After some discussion among the maintainers, "Pug" has been chosen as the new name for this project. The next major version will carry "pug" as the 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
Before the renaming, we had already begun working on an incompatible Jade 2.0.0. We have then made it so that this new major version bump will coincide with the rename to Pug. Therefore, upgrading from Jade to Pug will be the same process as upgrading any other package with a major version bump. Currently, Pug 2.0.0 is still under beta stage, and there are several syntactic differences we have deprecated and removed. Such differences are documented at #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 on npm.
$ npm install pug
After installing the latest version of Node.js, install with:
$ npm install pug-cli -g
and run with
$ pug --help
Pug is a clean, whitespace sensitive syntax for writing html. Here is a simple example:
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));
filenameUsed in exceptions, and required when using includes
falseno debug instrumentation is compiled
prettyAdd pretty-indentation whitespace to output (false by default)
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.
Implementations in other languages: