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
This commit is contained in:
Patrick Steele-Idem 2014-10-23 07:28:55 -06:00
parent 461f1a254f
commit a80b1d65f7
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -156,6 +156,12 @@ Hello ${data.name}!
</div> </div>
``` ```
To render the template you will need to install the `marko` module using [npm](https://www.npmjs.org/):
```bash
npm install marko --save
```
The template can then be rendered as shown in the following sample code: The template can then be rendered as shown in the following sample code:
```javascript ```javascript
@ -172,6 +178,7 @@ template.render({
``` ```
The output of running the above program will be the following (formatted for readability): The output of running the above program will be the following (formatted for readability):
```html ```html
Hello World! Hello World!
@ -182,7 +189,7 @@ Hello World!
</ul> </ul>
``` ```
For comparison, given the following data data consisting of an empty array of colors: For comparison, given the following data consisting of an empty array of colors:
```javascript ```javascript
{ {
@ -264,11 +271,13 @@ The custom tags encapsulate rendering logic and help avoid repeating the same HT
# Installation # Installation
To install the `marko` module into your project you should use the following command: To install the `marko` module into your project you should use the following command:
```bash ```bash
npm install marko --save npm install marko --save
``` ```
To install the optional `markoc` command line interface to compile templates you can use the following command: To install the optional `markoc` command line interface to compile templates you can use the following command:
```bash ```bash
npm install marko --global npm install marko --global
``` ```
@ -278,6 +287,7 @@ npm install marko --global
## Template Rendering ## Template Rendering
### Callback API ### Callback API
```javascript ```javascript
var template = require('marko').load('template.marko'); var template = require('marko').load('template.marko');
@ -1081,7 +1091,7 @@ For more details, please see [https://github.com/raptorjs/marko-layout](https://
## Tag Renderer ## Tag Renderer
Every tag should be mapped to a "renderer". A renderer is just a function that takes two arguments (`data` and `out`). The `data` argument is an arbitrary object that contains the data data for the renderer. The `out` argument is an [asynchronous rendering out](https://github.com/raptorjs/async-writer) that wraps an output stream. Output can be produced using `out.write(someString)` There is no class hierarchy or tie-ins to Marko when implementing a tag renderer. A simple tag renderer is shown below: Every tag should be mapped to a "renderer". A renderer is just a function that takes two arguments (`data` and `out`). The `data` argument is an arbitrary object that contains the data for the renderer. The `out` argument is an [asynchronous rendering out](https://github.com/raptorjs/async-writer) that wraps an output stream. Output can be produced using `out.write(someString)` There is no class hierarchy or tie-ins to Marko when implementing a tag renderer. A simple tag renderer is shown below:
```javascript ```javascript
module.exports = function(data, out) { module.exports = function(data, out) {