Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axfab/markup
Html template engine
https://github.com/axfab/markup
Last synced: about 2 months ago
JSON representation
Html template engine
- Host: GitHub
- URL: https://github.com/axfab/markup
- Owner: AxFab
- Created: 2014-10-29T11:11:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-01-16T10:28:53.000Z (almost 10 years ago)
- Last Synced: 2024-11-16T08:35:39.960Z (about 2 months ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HTML-Markup
HTML Template engine.
[](1)
[](2)
## Installation
npm install html-markup
In case you want to build a server using express as your router.
npm init
npm install express
npm install html-markup
## Features
- Complies with the [Express](3) view system
- Mark command tag using`#{ code /}`
## Commands
The markup language is composed of tag of this form:
#{command first_Arg, second_Arg, ... /}
The available commands are:
- __set__: Assign the value of the expression(2) to the variable name(1).
- __get__: Replace this tag by the value of the expression(1).
- __get_if__: If the condition(1) is true, replace this tag by the value of the expression(2) else by the second expression(3).
- __include__: Insert the content of the file indicate by the value of the expression(1).
- __doLayout___: Insert the content of the child template.
- __extends___: Define the parent of this template (see [extends](#extends)).
```html
#{set title,'MyPage' /}
#{set menu,'home' /}
#{extends '/model.html' /}
...
#{include '/menu-' + menu + '.html' /}
Bienvenue sur #{get title/}
```
## Usage
You can use this script of three different ways.
On command line:
> node markup.js [html_file]
On your script:
```js
var markup = require ('markup')
markup.renderFile(path, options, function (err, data) {
//...
});
```
Using Express:
```js
var markup = require('markup')
var express = require('express');
var app = express();
app.engine('html', markup.renderFile);
app.set('views', markup.directory); // specify the views directory
app.set('view engine', 'html'); // register the template engine
// What's on /dist folder is freely accessible
app.get('/dist', express.static(__dirname + '/dist'));
// For the rest, we use the engine
app.get('/', markup.lookFor)
app.listen(80);
```
## Options
- `cache` If true, will keep static page into memory.
- `params` Array of values accessible via `params.name`
- `query` Array of values accessible via `params.query`
- `debug` Output debug information
- `open` Open tag, defaulting to "#{
- `close` Closing tag, defaulting to "/}"
- `directory` Change of directory (default is `./views`)
## Extends
A real advantage about this template is to insert content of other pages.
You have two way of doing this, the extends and include commands.
The extends allow to define a parent. This is always the last executed command on the page.
## Example
##### ./views/model.html
```html
#{get title/}
...
...
#{include '/menu.html' /}
#{doLayout /}
...
```
##### ./views/index.html
```html
#{set title 'MyPage' /}
#{set menu, 'home' /}
#{extends '/models.html' /}
Welcome #{get_if query.user!=null, query.user, 'new visitor'}!
This is my page
```
##### ./views/menu.html
```html
```
##### RENDER (indentation corrected) /index.html?user=Fab
```html
MyPage
...
...
Welcome Fab!
This is my page
...
```
## License
This code is under the modified BSD license.
[1]: https://badge.fury.io/js/html-markup
[2]: http://travis-ci.org/axfab/markup
[3]: http://expressjs.com