pug README

The project's README from github.com/pugjs/pug. As one markdown file: README.md.

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

Build Status Rolling Versions NPM version Join Gitter Chat

Packages

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

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

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

Implementations in other languages

Ports in other languages

Ports to other languages, with very close syntax:

Equivalents in other languages

Templates engines for other languages with a different syntax, but a similar philosophy:

Framework implementations/adapters

Embedded view engines for frameworks:

CMS plugins

Additional Resources

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]

License

MIT

pug (pugjs/pug)

Searching Database…

21.8K ·GitHub
Pug
What is this?Pug is a high-performance template engine for Node.js and browsers, heavily influenced by Haml: you write HTML in a clean, whitespace-sensitive syntax and Pug compiles it.
Is it a library or a command-line tool?Both: an npm package for rendering templates in JavaScript projects, a CLI for compiling .pug files from the terminal, and a standalone build for browsers.
How do I get it running?Run 'npm install pug' in your JavaScript project, or install the Pug CLI to compile .pug files. You can also test-drive the syntax online at pugjs.org without installing anything.
Do I need Node.js installed first?Yes — the README says to install the latest version of Node.js first; Pug itself comes from npm, which ships with Node.
Can I run Pug templates directly in the browser?A standalone browser build exists, but it only supports the very latest browsers and is a large file, so pre-compiling templates to JavaScript is recommended; the CLI can emit filename.js for the client.
Is it free to use?Yes — Pug is released under the MIT license, so it is free for any use.
Old tutorials mention Jade — is that the same project?Yes. Pug was renamed from Jade because Jade turned out to be a registered trademark. As of version 2 'pug' is the official npm name, and upgrading is a normal major-version bump, though the syntax has documented deprecations and removals.
Are there Pug versions for other languages or frameworks?Close-syntax ports exist for PHP, Java, Python, Ruby, C# (ASP.NET Core) and RPG/ILE. There are also embedded view engines for Laravel, Symfony, Phalcon, CodeIgniter, Yii 2, Slim 3, Silex, Lumen and Rails, plus a WordPress plugin.
Does the compiler have useful options, like pretty output?Three documented options: 'filename' (used in exceptions and required for includes), 'compileDebug' to drop debug instrumentation, and 'pretty', which adds pretty-indentation whitespace to the output (off by default).
What editor support and helper tools exist around Pug?Syntax modes for Emacs, Vim, TextMate and Coda/SubEtha, an html2pug converter, a pug2php converter, a Prettier plugin, a standalone Pug Server for local prototypes, and cache-pug-templates for caching with Lad/Koa/Express/Connect over Redis.
What are similar projects?mustache.js, marked, lit, virtual-dom, MathJax, million, validator.js, cesium
Which topics is it in?template, rendering, monorepo, javascript-library, browser, html, backend, web-development, npm, frontend, tool, server
Creator
pugjs
Size
14.4 MB
Stars
21.8K
Updated
CommitMar 13Release[email protected]Mar 13
Age
16y
Commits · 90 Days