快速上手 Getting Started

Node 端使用

bash

$ npm install nunjucks

下载后可直接 require('nunjucks') 使用

可直接使用 nunjucks.js (min)，如果针对编译后的模板可使用 nunjucks-slim.js (min)。

nunjucks.js 可用于动态加载模板，当模板变化时重新加载，也可以用于预编译后的模板。包含编译器，所以会比较大 (20K min/gzipped)。如果你刚接触 nunjucks 可使用这个文件，如果你不在意大小也可以在生产环境使用。
nunjucks-slim.js 只能用于预编译后的模板，只包含运行时的代码，所以比较小 (8K min/gzipped)。一般用于生产环境，如果你使用 grunt 或gulp任务自动预编译，也可以在开发环境使用。

直接用 script 引入文件：

html

<script src="nunjucks.js"></script>

或者可以作为一个 AMD 模块加载：

define(['nunjucks'], (nunjucks) => {
})

确保在生产环境使用预编译版本，可使用 grunt 或gulp，可在浏览器使用查看客户端优化的配置。

这是最简单使用 nunjucks 的方式，首先设置配置项(如 autoescaping)，然后渲染一个字符串：

nunjucks.configure({ autoescape: true })
nunjucks.renderString('Hello {% raw %}{{ username }}{% endraw %}', { username: 'James' })

renderString 并不常用，而是使用 render 来直接渲染文件，这种方式支持继承(extends)和包含(include)模板。使用之前需要配置文件的路径：

nunjucks.configure('views', { autoescape: true })
nunjucks.render('index.html', { foo: 'bar' })

在 node 端，'views' 为相对于当前工作目录 (working directory) 的路径。在浏览器端则为一个相对的 url，最好指定为绝对路径 (如 '/views')。

如果使用 express 可直接传入 configure：

var app = express()

nunjucks.configure('views', {
  autoescape: true,
  express: app
})

app.get('/', (req, res) => {
  res.render('index.html')
})

上面的 API 适用于 node 端和浏览器端 (express 只适用于 node 端)，在 node 端 nunjucks 从文件系统加载模板，在浏览器端通过 http 加载模板。

如果你在浏览器上使用编译后的模板的话，你不需要额外做其他的事情系统也能够理解它们。这使得我们可以轻松地在开发环境和生产环境上使用同一份代码，并在生产环境上只使用已经编译过的模板。