pugjs/pug is a open-source project on GitHub, written primarily in JavaScript. It has 21.9k stars. Pug – robust, elegant, feature rich template engine for Node.js
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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:
$ pug --client --no-debug filename.pug
which will produce filename.js containing the compiled template.
Tutorials
cssdeck interactive Pug syntax tutorial
cssdeck interactive Pug logic tutorial
Pug について。 (A Japanese Tutorial)
Implementations in other languages
Ports in other languages
Ports to other languages, with very close syntax:
PHP
Java
Python
Ruby
C# (ASP.NET Core)
RPG/ILE
Equivalents in other languages
Templates engines for other languages with a different syntax, but a similar philosophy:
Scaml for Scala
Slim for Ruby (should not be confused with Slim PHP framework)
HAML for Ruby
Framework implementations/adapters
Embedded view engines for frameworks:
Laravel
Symfony
Phalcon
CodeIgniter
Yii 2
Slim 3
Silex (implementation example)
Lumen
Rails
CMS plugins
WordPress
Additional Resources
Emacs Mode
Vim Syntax
TextMate Bundle
Coda/SubEtha syntax Mode
html2pug converter
pug2php converter
Pug Server Ideal for building local prototypes apart from any application
cache-pug-templates Cache Pug templates for Lad/Koa/Express/Connect with Redis
Prettier Plugin
Backers
Support us with a monthly donation and help us continue our activities. [Become a backer]
Sponsors
Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]
TopGit's metadata for pugjs/pug does not record a license. Most public repositories on GitHub ARE open source, but the exact terms vary — verify by opening the LICENSE file directly.
What is pugjs/pug?
pugjs/pug (pugjs/pug) is a JavaScript project on GitHub. From the project's own README: Pug – robust, elegant, feature rich template engine for Node.js
Where do I read more about pugjs/pug?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/pugjs/pug is the definitive source.
Read full README in the tab above.
Curious whether pug is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about pug.
/pug
