1 | # Nunjucks
|
2 |
|
3 | [![NPM Version][npm-image]][npm-url]
|
4 | [![NPM Downloads][downloads-image]][downloads-url]
|
5 | [![Linux Build][github-actions-image]][github-actions-url]
|
6 | [![Windows Build][appveyor-image]][appveyor-url]
|
7 | [![Test Codecov][codecov-image]][codecov-url]
|
8 |
|
9 | [Nunjucks](https://mozilla.github.io/nunjucks/) is a full featured
|
10 | templating engine for javascript. It is heavily inspired by
|
11 | [jinja2](http://jinja.pocoo.org/). View the docs
|
12 | [here](https://mozilla.github.io/nunjucks/).
|
13 |
|
14 | ## Installation
|
15 |
|
16 | `npm install nunjucks`
|
17 |
|
18 | To use the file watcher built-in to Nunjucks, Chokidar must be installed separately.
|
19 |
|
20 | `npm install nunjucks chokidar`
|
21 |
|
22 | (View the [CHANGELOG](https://github.com/mozilla/nunjucks/releases))
|
23 |
|
24 | ## Documentation
|
25 |
|
26 | See [here](https://mozilla.github.io/nunjucks/).
|
27 |
|
28 | ## Browser Support
|
29 |
|
30 | Supported in all modern browsers. For IE8 support, use [es5-shim](https://github.com/es-shims/es5-shim).
|
31 |
|
32 | ## Tests
|
33 |
|
34 | Run the tests with `npm test`.
|
35 |
|
36 | Watch `master` branch's [tests running in the browser](https://mozilla.github.io/nunjucks/files/tests/browser/).
|
37 |
|
38 | ## Mailing List
|
39 |
|
40 | Join our mailing list and get help with and issues you have:
|
41 | https://groups.google.com/forum/?fromgroups#!forum/nunjucks
|
42 |
|
43 | ## Want to help?
|
44 |
|
45 | Contributions are always welcome! Before you submit an issue or pull request, please read our [contribution guidelines](CONTRIBUTING.md).
|
46 |
|
47 | [Contributors](https://github.com/mozilla/nunjucks/graphs/contributors)
|
48 |
|
49 | [npm-image]: https://img.shields.io/npm/v/nunjucks.svg
|
50 | [npm-url]: https://npmjs.org/package/nunjucks
|
51 | [downloads-image]: https://img.shields.io/npm/dm/nunjucks.svg
|
52 | [downloads-url]: https://npmjs.org/package/nunjucks
|
53 | [github-actions-image]: https://img.shields.io/github/workflow/status/mozilla/nunjucks/Tests/master.svg?label=linux
|
54 | [github-actions-url]: https://github.com/mozilla/nunjucks/actions
|
55 | [appveyor-image]: https://img.shields.io/appveyor/ci/fdintino/nunjucks/master.svg?label=windows
|
56 | [appveyor-url]: https://ci.appveyor.com/project/fdintino/nunjucks
|
57 | [codecov-image]: https://img.shields.io/codecov/c/gh/mozilla/nunjucks.svg
|
58 | [codecov-url]: https://codecov.io/gh/mozilla/nunjucks/branch/master
|