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
这是什么?Pug 是一个用于 Node.js 和浏览器的高性能模板引擎,深受 Haml 影响:你用简洁、对缩进敏感的语法来写 HTML,然后由 Pug 把它编译出来。
它是一个库还是命令行工具?两者都是:它是一个 npm 包,可以在 JavaScript 项目里渲染模板;也是一个命令行工具,可以在终端里编译 .pug 文件;还提供了浏览器用的独立构建版本。
我怎么把它跑起来?在你的 JavaScript 项目里运行 'npm install pug',或者安装 Pug CLI 来编译 .pug 文件。你也可以什么都不装,直接在 pugjs.org 上在线试用它的语法。
我需要先安装 Node.js 吗?需要——README 说明要先安装最新版的 Node.js;Pug 本身来自 npm,而 npm 是随 Node 一起附带的。
我能直接在浏览器里运行 Pug 模板吗?有面向浏览器的独立构建版本,但它只支持非常新的浏览器,而且文件体积很大,所以建议把模板预编译成 JavaScript;CLI 可以为客户端生成 filename.js 这样的文件。
它是免费的吗?是的——Pug 采用 MIT 许可证发布,任何用途都可以免费使用。
一些老教程里提到 Jade——那是同一个项目吗?是的。Pug 原来叫 Jade,后来因为 Jade 被发现是注册商标而改名。从第 2 版起,'pug' 是 npm 上的官方名称,升级就是一次普通的大版本升级,不过语法上有一些已记录的弃用和移除项。
其他语言或框架有没有 Pug 的版本?PHP、Java、Python、Ruby、C#(ASP.NET Core)和 RPG/ILE 都有语法相近的移植版。还有面向 Laravel、Symfony、Phalcon、CodeIgniter、Yii 2、Slim 3、Silex、Lumen 和 Rails 的嵌入式视图引擎,以及一个 WordPress 插件。
编译器有哪些实用的选项,比如输出美化?文档里写了三个选项:'filename'(用于异常信息,使用 include 时必填)、'compileDebug' 用于去掉调试相关的插桩代码,以及 'pretty',它会给输出加上缩进空白让格式更好看(默认关闭)。
围绕 Pug 有哪些编辑器支持和辅助工具?有 Emacs、Vim、TextMate 和 Coda/SubEtha 的语法高亮模式,还有 html2pug 转换器、pug2php 转换器、一个 Prettier 插件、用于本地原型开发的独立 Pug Server,以及配合 Lad/Koa/Express/Connect 在 Redis 上做缓存的 cache-pug-templates。
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, backend, html, 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