https://github.com/chrisdothtml/node-etml
etml Node module
https://github.com/chrisdothtml/node-etml
Last synced: about 2 months ago
JSON representation
etml Node module
- Host: GitHub
- URL: https://github.com/chrisdothtml/node-etml
- Owner: chrisdothtml
- Created: 2015-09-04T13:57:40.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-24T16:16:03.000Z (almost 11 years ago)
- Last Synced: 2025-03-23T16:43:15.329Z (over 1 year ago)
- Language: CoffeeScript
- Homepage:
- Size: 317 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
node-etml
===
> A preprocessor that enhances HTML
**NOTE: ETML IS AN IN-PROGRESS PROJECT. DOCUMENTATION FOR ETML-API AND NODE-ETML IS STRICTLY FOR POST-RELEASE AND SHOULD NOT BE REFERENCED DURING CURRENT DEVELOPMENT. NEITHER MODULES ARE AVAILABLE ON NPM AS OF YET.**
This is a module that allows for etml usage within Node. For etml docs, visit [etml-api](https://github.com/chrisdothtml/etml-api). To report an issue/suggestion, please do it [here](https://github.com/chrisdothtml/etml-api/issues).
For etml usage with Grunt, visit [grunt-etml](https://github.com/chrisdothtml/grunt-etml).
## Installation
```
npm install node-etml
```
## Usage
Including the module
```js
var etml = require('node-etml');
```
Running etml
```js
// to compile etml on the fly (returns with HTML string)
etml.src(src, options);
// to compile one file
etml.file('path/to/src/file.etml', 'path/to/dest/', options);
// to compile all .etml files in a directory
etml.file('path/to/src/', 'path/to/dest/', options);
```
## Options
#### bfe
Type: `Boolean`
Default value: `true`
When this is set to `true`, it will use [better-fs-errors](https://github.com/chrisdothtml/better-fs-errors) for its filesystem error reporting.