# express-liquid

> A liquid template engine for Express

Latest version **0.2.6** (published 2014-11-03) · 0 weekly downloads

## Install

```sh
npm install express-liquid
pnpm add express-liquid
yarn add express-liquid
bun add express-liquid
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2014-11-03 |
| First published | 2012-08-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Lei Zongmin |
| Maintainers | leizongmin |
| Keywords | liquid, template |

## Links

- npm: https://www.npmjs.com/package/express-liquid
- Repository: https://github.com/leizongmin/express-liquid
- Issues: https://github.com/leizongmin/express-liquid/issues
- npm.io page: https://npm.io/package/express-liquid

## Dependencies (1)

- [tinyliquid](https://npm.io/package/tinyliquid.md) 0.2.x

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.6 (latest) — 2014-11-03
- 0.2.5 — 2014-05-07
- 0.2.4 — 2013-12-11
- 0.2.3 — 2013-09-18
- 0.2.2 — 2013-08-19
- 0.2.0 — 2013-03-25
- 0.0.2 — 2012-10-13
- 0.0.1 — 2012-08-09

## README

Express-Liquid [![Build Status](https://secure.travis-ci.org/leizongmin/express-liquid.png?branch=master)](http://travis-ci.org/leizongmin/express-liquid) [![Dependencies Status](https://david-dm.org/leizongmin/express-liquid.png)](http://david-dm.org/leizongmin/express-liquid)
==============

![express-liquid](https://nodei.co/npm/express-liquid.png)

Install
=======

```bash
npm install express-liquid --save
```


Using TinyLiquid in Express 3.x & 4.x
===============================

## 1. Initialization

```javascript
var expressLiquid = require('express-liquid');
var options = {
  // read file handler, optional
  includeFile: function (filename, callback) {
    fs.readFile(filename, 'utf8', callback);
  },
  // the base context, optional
  context: expressLiquid.newContext(),
  // custom tags parser, optional
  customTags: {},
  // if an error occurred while rendering, show detail or not, default to false
  traceError: false
};
app.set('view engine', 'liquid');
app.engine('liquid', expressLiquid(options));
app.use(expressLiquid.middleware);
```

More about **TinyLiquid**, see https://github.com/leizongmin/tinyliquid

## 2. Render a template

```javascript
res.render('template_name', {a: 'hello', b: 'world'});
```

or

```javascript
res.locals.a = 'hello';
res.locals.b = 'world';
res.render('template_name');
```

## 3. About the **include** tag: {% include %}

The root directory is **views**, for example: {% include "abc/efg" %} will include the file "abc/edf" under the "views" directory

If your want to use a relative file path, please add the "./" or "../" prefix. For example:

```
{% include "./path/to" %}
{% include "../path/to" %}
```

**Usually, you may omit template file name suffix, then it will try to add a subffix name from the configuration `view engine`**

## 4. Changing the default views directory

```JavaScript
app.set('views', '/path/to/views');
```


License
=======

You can feel free to use and distribute it under the premise of compliance with the **MIT Licence**.

    Copyright (c) 2012-2013 Zongmin Lei <leizongmin@gmail.com>
    http://ucdok.com

    The MIT License

    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/express-liquid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._