44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
|
# build_jael
|
||
|
|
[](https://pub.dartlang.org/packages/build_jael)
|
||
|
|
[](https://travis-ci.org/angel-dart/jael)
|
||
|
|
|
||
|
|
|
||
|
|
Compile Jael files to HTML using the power of `package:build`.
|
||
|
|
|
||
|
|
# Installation
|
||
|
|
In your `pubspec.yaml`:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
dependencies:
|
||
|
|
build_jael: ^1.0.0
|
||
|
|
dev_dependencies:
|
||
|
|
build_runner: ^0.7.0
|
||
|
|
```
|
||
|
|
|
||
|
|
# Usage
|
||
|
|
You can run `pub run build_runner serve` to incrementally build Jael templates,
|
||
|
|
and run an HTTP server.
|
||
|
|
|
||
|
|
For further customization, you'll need to either modify the `build.yaml` or
|
||
|
|
instantiate a `JaelBuilder` manually.
|
||
|
|
|
||
|
|
## Defining Variables
|
||
|
|
Pass variables as `config` in `build.yaml`:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
targets:
|
||
|
|
$default:
|
||
|
|
builders:
|
||
|
|
build_jael:
|
||
|
|
config:
|
||
|
|
foo: bar
|
||
|
|
baz: quux
|
||
|
|
one: 1.0
|
||
|
|
```
|
||
|
|
|
||
|
|
## Minifying HTML
|
||
|
|
Pass `minify: true` in the build configuration to produce "minified" HTML,
|
||
|
|
without newlines or whitespace (other than where it is required).
|
||
|
|
|
||
|
|
To apply additional transforms to parsed documents, provide a
|
||
|
|
set of `patch` functions, like in `package:jael_preprocessor`.
|