archive-gh-me/marko
1
0
Fork 0
mirror of https://github.com/marko-js/marko.git synced 2025-12-08 19:26:05 +00:00
Code Issues Projects Releases Wiki Activity

Updated README.md

Browse Source 
Use the Node.js require extension everywhere
This commit is contained in:
Patrick Steele-Idem 2015-06-26 10:18:14 -06:00
parent fb9067b219
commit b1f4d58e8c
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -369,7 +369,7 @@ template.render({
### Streaming API ### Streaming API
```javascript ```javascript
var template = require('marko').load('template.marko'); var template = require('./template.marko');
var out = require('fs').createWriteStream('index.html', {encoding: 'utf8'}); var out = require('fs').createWriteStream('index.html', {encoding: 'utf8'});
// Render the template to 'index.html' // Render the template to 'index.html'
@ -383,7 +383,7 @@ template.stream({
Alternatively, you can render directly to an existing stream to avoid creating an intermediate stream: Alternatively, you can render directly to an existing stream to avoid creating an intermediate stream:
```javascript ```javascript
var template = require('marko').load('template.marko'); var template = require('./template.marko');
var out = require('fs').createWriteStream('index.html', {encoding: 'utf8'}); var out = require('fs').createWriteStream('index.html', {encoding: 'utf8'});
// Render the template to 'index.html' // Render the template to 'index.html'
@ -399,7 +399,7 @@ _NOTE:_ This will end the target output stream.
If you know that your template rendering requires no asynchronous rendering then you can use the synchronous API to render a template to a String: If you know that your template rendering requires no asynchronous rendering then you can use the synchronous API to render a template to a String:
```javascript ```javascript
var template = require('marko').load('template.marko'); var template = require('./template.marko');
var output = template.renderSync({ var output = template.renderSync({
name: 'Frank', name: 'Frank',
@ -412,8 +412,7 @@ console.log('Output HTML: ' + output);
```javascript ```javascript
var fs = require('fs'); var fs = require('fs');
var marko = require('marko'); var template = require('./template.marko');
var template = marko.load('template.marko');
var out = marko.createWriter(fs.createWriteStream('index.html', {encoding: 'utf8'})); var out = marko.createWriter(fs.createWriteStream('index.html', {encoding: 'utf8'}));
@ -1443,7 +1442,7 @@ Example usage:
```javascript ```javascript
var templatePath = require.resolve('./template.marko'); var templatePath = require.resolve('./template.marko');
var template = require('marko').load(templatePath); var template = require('marko')require('marko')(templatePath);
template.render({ name: 'Frank' }, process.stdout); template.render({ name: 'Frank' }, process.stdout);
``` ```