Jade模板引擎入門教程
阿新 • • 發佈：2017-06-03
undefine 文件 ech content arrays str www versions contain
Jade是一款高性能簡潔易懂的模板引擎，Jade是Haml的Javascript實現，在服務端（NodeJS）及客戶端均有支持。
功能
- 客戶端支持
- 超強的可讀性
- 靈活易用的縮進
- 塊擴展
- 代碼默認經過編碼處理以增強安全性
- 編譯及運行時的上下文錯誤報告
- 命令行編譯支持
- HTML5模式（使用!!!5文檔類型）
- 可選的內存緩存
- 聯合動態和靜態標記類
- 利用過濾器解析樹的處理
- 支持 Express JS
- 利用each透明的循環objects,arrays甚至不可枚舉對象
- 塊註釋
- 不需要標記前綴
- AST過濾器
- 過濾器
- :sass 需要安裝sass.js
- :less 需要安裝less.js
- :markdown 需要安裝markdown-js或node-discount
- :cdata
- :coffeescript 需要安裝coffee-script
- Vim語法文件
- TextMate包
- Screencasts
其它語言實現
- php
- Scala
- Ruby
安裝
通過npm：
| 1 2 |
<span style="font-size: 13px;">npm install jade
</span>
|
瀏覽器支持
可以通過下面命令將jade編譯為客戶端瀏覽器兼容的文件：
| 1 2 |
<span style="font-size: 13px;">$ make jade.js
</span> |
或者，如果你已經通過npm安裝了uglifyjs（npminstalluglify-js），可以通過下面的命令同時創建兩個文件：
| 1 2 |
<span style="font-size: 13px;">$ make jade.min.js
</span>
|
公開API
var jade = require(‘jade‘);
// 渲染字符串
jade.render(‘.csser.com 字符串‘, { options: ‘here‘ });
// 渲染文件
jade.renderFile(‘path/to/csser.com.jade‘, { options: ‘here‘ }, function(err, html){
// 這裏的options是可選的
// 回調函數可以作為第二個參數
});
// 編譯一個函數
var fn = jade.compile(‘string of jade‘, options);
fn.call(scope, locals);
Options
- 執行作用域（this）scope
- 本地變量對象locals
- 處理異常及緩存時使用filename
- 通過文件名將Javascript緩存在內存中cache
- 輸出生成的標記和函數體debug
- 替換jade默認編譯引擎compiler
語法
行尾
在解析前會將 CRLF 和 CR 轉換為 LF.
標記
標記是一行的第一個單詞：
| 1 2 |
<span style="font-size: 13px;">html
</span>
|
會被轉換為 <html></html>
標記也可以有id：
| 1 2 |
<span style="font-size: 13px;">div#container
</span>
|
這將被渲染成<div id=”container”></div>
如何處理類？
| 1 2 |
<span style="font-size: 13px;">div.user-details
</span>
|
渲染為: <div class=”user-details”></div>
多個class？並且還有id？
| 1 2 |
<span style="font-size: 13px;">div#foo.bar.baz
</span>
|
渲染為：<div id=”foo” class=”bar baz”></div>
總寫div確實很煩人，可以省略之：
| 1 2 3 |
<span style="font-size: 13px;">#foo
.bar
</span>
|
輸出： <div id=”foo”></div><div class=”bar”></div>
標記文本
只需要將文本內容放在標記後面：
| 1 2 |
<span style="font-size: 13px;">p wahoo!
</span>
|
渲染為 <p>wahoo!</p>.
酷，但是如何處理大段文本呢？
| 1 2 3 4 5 6 |
<span style="font-size: 13px;">p
| foo bar baz
| rawr rawr
| super cool
| go jade go
</span>
|
渲染為 <p>foo bar baz rawr…..</p>
內插法？是的，這兩種類型的文本都可以使用內插法，如果我們傳入{ locals: { name: ‘一回’, email: ‘xianlihua[at]gmail.com’ }}，可以這樣做：
| 1 2 |
<span style="font-size: 13px;">#user #{name} <#{email}>
</span>
|
輸出：<div id=”user”>一回 <xianlihua[at]gmail.com></div>
出於某種原因需要輸出#{}？轉義之：
| 1 2 |
<span style="font-size: 13px;">p \#{CSSer, 關註Javascript技術}
</span>
|
這樣就得到了：<p>#{CSSer, 關註Javascript技術}</p>
也可以使用反轉義變量!{html}，下面的代碼將輸出script標記：
| 1 2 3 |
<span style="font-size: 13px;">- var html = "<script></script>"
| !{html}
</span>
|
包含文本的嵌套標記也可以使用文本塊：
| 1 2 3 4 |
<span style="font-size: 13px;">label
| Username:
input(name=‘user[name]‘)
</span>
|
或者直接使用標記文本:
| 1 2 3 |
<span style="font-size: 13px;">label Username:
input(name=‘user[name]‘)
</span>
|
只接受純文本的標記，如script,style,以及textarea不需要開頭的|字符，例如：
| 1 2 3 4 5 6 7 8 9 10 |
<span style="font-size: 13px;"> html
head
title CSSer, 關註Web前端技術
script
if (foo) {
bar();
} else {
baz();
}
</span>
|
再次作為替代方案，我們可以使用點號’.‘來表示一個文本塊，例如：
| 1 2 3 4 5 6 7 |
<span style="font-size: 13px;"> p.
foo asdf
asdf
asdfasdfaf
asdf
asd.
</span>
|
輸出:
| 1 2 3 4 5 6 7 8 |
<span style="font-size: 13px;"> <p>foo asdf
asdf
asdfasdfaf
asdf
asd
.
</p>
</span>
|
如果點號’.‘與標記之間有空格，Jade解析其會忽略它，將其作為文本處理：
| 1 2 |
<span style="font-size: 13px;">p .
</span>
|
輸出:
| 1 2 |
<span style="font-size: 13px;"><p>.</p>
</span>
|
註釋
單行註釋當前看起來與Javascript一致，即“//”，單行註釋的內容必須放在同一行上：
| 1 2 3 4 |
<span style="font-size: 13px;">// 一些段落
p foo
p bar
</span>
|
將會輸出：
| 1 2 3 4 |
<span style="font-size: 13px;"><!-- 一些段落 -->
<p>foo</p>
<p>bar</p>
</span>
|
Jade也支持非緩沖註釋，只需增加一個橫杠：
| 1 2 3 4 |
<span style="font-size: 13px;">//- 該行註釋將不會被輸出到解析後的頁面中
p foo
p bar
</span>
|
輸出：
| 1 2 3 |
<span style="font-size: 13px;"><p>foo</p>
<p>bar</p>
</span>
|
塊註釋
塊註釋會依據縮進進行處理：
| 1 2 3 4 5 |
<span style="font-size: 13px;"> body
//
#content
h1 CSSer,關註Web前端技術
</span>
|
輸出：
| 1 2 3 4 5 6 7 8 |
<span style="font-size: 13px;"><body>
<!--
<div id="content">
<h1>CSSer,關註Web前端技術</h1>
</div>
-->
</body>
</span>
|
Jade也支持條件註釋，例如：
| 1 2 3 4 |
<span style="font-size: 13px;">body
/if IE
a(href=‘http://www.mozilla.com/en-US/firefox/‘) Get Firefox
</span>
|
輸出:
| 1 2 3 4 5 6 |
<span style="font-size: 13px;"><body>
<!--[if IE]>
<a href="http://www.mozilla.com/en-US/firefox/">Get Firefox</a>
<![endif]-->
</body>
</span>
|
嵌套
Jade支持通過嵌套來以自然的方式定義標記：
| 1 2 3 4 5 6 7 8 |
<span style="font-size: 13px;">ul
li.first
a(href=‘#‘) foo
li
a(href=‘#‘) bar
li.last
a(href=‘#‘) baz
</span>
|
塊擴展
塊擴展允許創建單行的簡潔嵌套標記，下面的示例與上例輸出相同：
| 1 2 3 4 5 |
<span style="font-size: 13px;"> ul
li.first: a(href=‘#‘) foo
li: a(href=‘#‘) bar
li.last: a(href=‘#‘) baz
</span>
|
特性
目前Jade支持’(‘和’)‘的特性定界符。
| 1 2 |
<span style="font-size: 13px;">a(href=‘/login‘, title=‘View login page‘) Login
</span>
|
另外我們也可以使用冒號（:）來作為分割符：
| 1 2 |
<span style="font-size: 13px;">a(href: ‘/login‘, title: ‘註冊成為CSSer.com會員‘) Login
</span>
|
Boolean特性也被支持：
| 1 2 |
<span style="font-size: 13px;">input(type="checkbox", checked)
</span>
|
值為變量的Boolean特性只有在值為true時輸出：
| 1 2 |
<span style="font-size: 13px;">input(type="checkbox", checked: someValue)
</span>
|
分拆在多行也能正常解析：
| 1 2 3 4 |
<span style="font-size: 13px;">input(type=‘checkbox‘,
name=‘agreement‘,
checked)
</span>
|
文檔類型
利用!!!來增加頁面的文檔類型：
| 1 2 |
<span style="font-size: 13px;">!!!
</span>
|
將會輸出過渡型文檔類型，然而：
| 1 2 |
<span style="font-size: 13px;">!!! 5
</span>
|
將會輸出HTML5的文檔類型，下面是默認定義的文檔類型，這也可以很容易的被擴展：
var doctypes = exports.doctypes = {
‘5‘: ‘<!DOCTYPE html>‘,
‘xml‘: ‘<?xml version="1.0" encoding="utf-8" ?>‘,
‘default‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">‘,
‘transitional‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">‘,
‘strict‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">‘,
‘frameset‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">‘,
‘1.1‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">‘,
‘basic‘: ‘<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">‘,
‘mobile‘: ‘<!DOCTYPE html PUBLIC "-//WAPFORUM//DTD XHTML Mobile 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/xhtml-mobile12.dtd">‘
};
要修改默認值只需改變：
| 1 2 |
<span style="font-size: 13px;">jade.doctypes.default = ‘whatever you want‘;
</span>
|
過濾器
過濾器以冒號（:）作為前綴，如 :markdown 將會對文本進行函數處理，（一回註：類似Smarty的變量調節器），本頁開始處列出了目前Jade支持的過濾器。
| 1 2 3 4 5 |
<span style="font-size: 13px;">body
:markdown
Woah! jade _and_ markdown, very **cool**
we can even link to [CSSer](http://www.csser.com)
</span>
|
渲染後:
| 1 2 |
<span style="font-size: 13px;"> <body><p>Woah! jade <em>and</em> markdown, very <strong>cool</strong> we can even link to <a href="http://www.csser.com">CSSer</a></p></body>
</span>
|
過濾器也可以處理解析樹，通常過濾器可以正常處理文本塊，但是通過傳入規則的塊過濾器可以做任何它能做的。
| 1 2 3 4 5 6 7 |
<span style="font-size: 13px;">body
conditionals:
if role == ‘admin‘
p You are amazing
else
p Not so amazing
</span>
|
代碼
Jade目前支持三種類型的可執行代碼，第一種以-為前綴，不會被緩沖：
| 1 2 |
<span style="font-size: 13px;">- var foo = ‘bar‘;
</span>
|
這可被用於條件或循環：
| 1 2 3 |
<span style="font-size: 13px;">- for (var key in obj)
p= obj[key]
</span>
|
由於Jade的緩沖技術，下面的代碼是有效的：
| 1 2 3 4 5 6 7 8 |
<span style="font-size: 13px;">- if (foo)
ul
li yay
li foo
li worked
- else
p oh no! you are not in csser.com
</span>
|
甚至詳細的叠代循環：
| 1 2 3 4 5 6 |
<span style="font-size: 13px;">- if (items.length)
ul
- items.forEach(function(item){
li= item
- })
</span>
|
任何你希望的都可以實現！
接下來我們轉義了緩沖代碼，用於緩沖返回值，以等號（=）作為前綴：
| 1 2 3 4 |
<span style="font-size: 13px;">- var foo = ‘bar‘
= foo
h1= foo
</span>
|
輸出： bar<h1>bar</h1>. 被’=‘緩沖的代碼會默認經過轉義以增強安全性，要輸出為轉義的值需要使用 !=：
| 1 2 |
<span style="font-size: 13px;">p!= aVarContainingMoreHTML
</span>
|
一個允許使用”vanilla”Javascript的例外，是 – each 標記，其表現形式為：
| 1 2 |
<span style="font-size: 13px;">- each VAL[, KEY] in OBJ
</span>
|
實現循環數組的例子：
| 1 2 3 4 |
<span style="font-size: 13px;">- var items = ["one", "two", "three"]
- each item in items
li= item
</span>
|
輸出:
| 1 2 3 4 |
<span style="font-size: 13px;"><li>one</li>
<li>two</li>
<li>three</li>
</span>
|
循環對象的鍵和值：
| 1 2 3 4 |
<span style="font-size: 13px;">- var obj = { foo: ‘bar‘ }
- each val, key in obj
li #{key}: #{val}
</span>
|
這會輸出 <li>foo: bar</li>
也可以進行嵌套循環：
| 1 2 3 4 |
<span style="font-size: 13px;">- each user in users
- each role in user.roles
li= role
</span>
|
當一個屬性為undefined，Jade會輸出空串，例如：
| 1 2 |
<span style="font-size: 13px;">textarea= user.signature
</span>
|
近期的Jade版本會輸出空字符串而不是undefined：
| 1 2 |
<span style="font-size: 13px;"><textarea></textarea>
</span>
|
命令行工具：bin/jade
輸出html到標準輸出（stdout）：
| 1 2 |
<span style="font-size: 13px;">jade examples/*.jade --pipe
</span>
|
生成 examples/*.html ：
| 1 2 |
<span style="font-size: 13px;">jade examples/*.jade
</span>
|
傳入參數：
| 1 2 |
<span style="font-size: 13px;">jade examples/layout.jade --options ‘{ locals: { title: "CSSer" }}‘
</span>
|
Jade模板引擎入門教程