Full documentation is at pugasync.com
Pug is a high-performance template engine implemented with JavaScript for Node.js and browsers. For bug reports, feature requests and questions, open an issue.
You can test drive Pug online here.
| 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 |  |
To use Pug in your own JavaScript projects:
$ npm install pugAfter installing the latest version of Node.js, install with:
$ npm install pug-cli -gand run with
$ pug --helpPug 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>For full API, see pugasync.com/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 includescompileDebugWhenfalseno debug instrumentation is compiledprettyAdd pretty-indentation whitespace to output (falseby default)
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.pugwhich will produce filename.js containing the compiled template.
- cssdeck interactive Pug syntax tutorial
- cssdeck interactive Pug logic tutorial
- Pug について。 (A Japanese Tutorial)
Ports to other languages, with very close syntax:
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
Embedded view engines for frameworks:
- 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