platform/README.md

34 lines
1,022 B
Markdown
Raw Normal View History

2017-04-05 18:37:26 +00:00
# mustache
2017-04-05 22:43:15 +00:00
[![version 1.0.1](https://img.shields.io/badge/pub-1.0.1-brightgreen.svg)](https://pub.dartlang.org/packages/angel_mustache)
[![build status](https://travis-ci.org/angel-dart/mustache.svg?branch=master)](https://travis-ci.org/angel-dart/mustache)
2017-04-05 18:38:35 +00:00
Mustache (Handlebars) view generator for the [Angel](https://github.com/angel-dart/angel)
web server framework.
2016-04-22 02:22:33 +00:00
2017-04-05 22:43:15 +00:00
Thanks so much @c4ward for his help with bringing this project to life!
2016-04-22 02:22:33 +00:00
# Installation
In `pubspec.yaml`:
2017-04-05 18:37:26 +00:00
```yaml
dependencies:
angel_mustache: ^1.0.0
```
If your project imports [`package:angel_common`](https://github.com/angel-dart/common),
then this is already installed.
2016-04-22 02:22:33 +00:00
# Usage
2017-04-05 18:38:35 +00:00
```dart
2017-04-05 18:37:26 +00:00
// Run the plug-in
await app.configure(mustache(new Directory('views')));
2016-04-22 02:22:33 +00:00
2017-04-05 18:37:26 +00:00
// Render `hello.mustache`
2017-04-05 18:38:59 +00:00
await res.render('hello', {'name': 'world'});
2016-05-02 23:28:37 +00:00
```
# Options
- **partialsPath**: A path within the viewsDirectory to search for partials in.
2017-04-05 18:37:47 +00:00
Default is `./partials`.
2017-04-05 18:37:26 +00:00
- **fileExtension**: The file extension to search for. Default is `.mustache`.