Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JiangJie/koa-swig-render
Koa view render based on Swig, support tags, filters, and extensions.
https://github.com/JiangJie/koa-swig-render
Last synced: 25 days ago
JSON representation
Koa view render based on Swig, support tags, filters, and extensions.
- Host: GitHub
- URL: https://github.com/JiangJie/koa-swig-render
- Owner: JiangJie
- License: mit
- Created: 2015-01-13T16:43:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-01-14T07:01:55.000Z (almost 10 years ago)
- Last Synced: 2024-11-09T18:32:54.687Z (about 1 month ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-koa - koa-swig-render - [swig](http://paularmstrong.github.io/swig/)视图渲染中间件.   (仓库 / 中间件)
README
# koa-swig-render
[![NPM version][npm-img]][npm-url]
[![Build status][travis-img]][travis-url]
[![Test coverage][coveralls-img]][coveralls-url]
[![License][license-img]][license-url]
[![Dependency status][david-img]][david-url]
Forked from [koa-swig](https://github.com/koa-modules/koa-swig), but the usage is a little difference. That is ~~`render(app, {});`~~`app.use(render());`
[Koa][] view render based on [Swig][], support tags, filters, and extensions.
[](https://nodei.co/npm/koa-swig-render/)
### Usage
#### Install
```
npm install koa-swig-render
```
#### Features
* First, automatically merge `ctx.state` from koa 0.14.
* Second, automatically merge `ctx.flash`.
* Finally, merge custom locals.
#### Example
```js
var koa = require('koa');
var render = require('koa-swig');
var app = koa();
app.use(render({
root: path.join(__dirname, 'views'),
autoescape: true,
cache: 'memory', // disable, set to false
ext: 'html',
locals: locals,
filters: filters,
tags: tags,
extensions: extensions
}));
app.use(function *() {
yield* this.render('index');
});
app.listen(2333);
```
#### Settings
* [swig options](http://paularmstrong.github.io/swig/docs/api/#SwigOpts)
- autoescape
- cache
- locals
- varControls
* filters: swig custom [filters](http://paularmstrong.github.io/swig/docs/extending/#filters)
* tags: swig custom [tags](http://paularmstrong.github.io/swig/docs/extending/#tags)
* extensions: add extensions for custom tags
* ext: default view extname
* root: view root directory
* writeBody: default(true) auto write body and response
#### Others
* [swig-extras](https://github.com/paularmstrong/swig-extras) A collection of handy tags, filters, and extensions for Swig.
### Licences
MIT
[koa]: http://koajs.com
[swig]: http://paularmstrong.github.io/swig/
[npm-img]: https://img.shields.io/npm/v/koa-swig-render.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa-swig-render
[travis-img]: https://img.shields.io/travis/JiangJie/koa-swig-render.svg?style=flat-square
[travis-url]: https://travis-ci.org/JiangJie/koa-swig-render
[coveralls-img]: https://img.shields.io/coveralls/JiangJie/koa-swig-render.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/JiangJie/koa-swig-render?branch=master
[license-img]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
[license-url]: LICENSE
[david-img]: https://img.shields.io/david/JiangJie/koa-swig-render.svg?style=flat-square
[david-url]: https://david-dm.org/JiangJie/koa-swig-render