Package Exports
- express-posthtml
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (express-posthtml) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Install
npm i -S express-posthtml
Usage
Engine
Register PostHTML as Express View Engine
app.engine('html', require('express-posthtml'))
Options
Name | Type | Default | Description |
---|---|---|---|
plugins |
{Array} |
[] |
PostHTML Plugins |
options |
{Object} |
{} |
PostHTML Options |
Global
All views will render with this setup, if no local setup provided.
app.set('view options', { plugins: [], options: {} })
res.render('file.ext')
Local
View specific setup by adding plugins separately to the respective routes. Note that if you have set plugins globally, routes with local setup will not use the global setup by default.
app.set('view options', { options: { parser: pug }})
res.render('file.pug', { plugins: [...plugins] })
Extend
If views share common plugins (e.g for BEM Support), but view specific additions are necessary, use the extend option. Now the global setup is used and will be extended with the local plugins of the respective route.
app.set('view options', { plugins: [...plugins], options: {} })
res.render('file', { plugins: [/* PostHTML Plugins */], extend: true })
Example
import express from 'express'
import posthtml from 'express-posthtml'
const app = express()
app.engine('html', require('posthtml'))
const plugins = [
require('posthtml-bem')()
require('posthtml-expressions')()
]
const options = {}
app.set('views', /* Path to views */)
app.set('view options', { plugins: plugins, options: options })
app.get('/', (req, res) => res.render('index.html'))
app.listen(3000)
Maintainers
Michael Ciniawsky |