Socket
Socket
Sign inDemoInstall

layout-wrapper

Package Overview
Dependencies
73
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    layout-wrapper

Wrap the contents in the layout template. gulpfriendly.


Version published
Weekly downloads
28
decreased by-3.45%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

layout-wrapper v1.0.0

Wrap the contents in the layout template. gulpfriendly.

Install

npm install layout-wrapper

Usage

This module works with gulp's file stream.

gulpfile.js:

const frontMatter = require('gulp-front-matter')
const wrapper = require('layout-wrapper')

gulp.src('src/pages/*.html')
  .pipe(frontMatter())
  .pipe(wrapper({
    layout: 'src/layouts'
    data: {name: 'world'},
    engine: 'nunjucks'
  }))
  .pipe(gulp.dest('site/'))

src/pages/sample.html

---
title: Hello
layout: default
---
<p>Hello, {{ name }}!</p>

src/layouts/default.nunjucks:

<html>
<head>
  <title>{{ file.frontMatter.title }}</title>
</head>
<body>
  {{ contents }}
</body>
</html>

The above settings outputs the following html into the path site/sample.html:

<html>
<head>
  <title>Hello</title>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

API

const wrapper = require('layout-wrapper')

wrapper(options)

  • @param {object} options - The options
  • @param {string} options.layout - The path to the directory of layout files. If nothing is given, then this throws an error. Required.
  • @param {string} [options.engine] - The name of the template engine. Default is lodash. Please see the document of consolidate.js for what's available here.
  • @param {object} [options.data] - The additional data which is passed to the layout engine.
  • @param {string} [options.frontMatterProp] - The name of the property where the front matter object is stored in vinyl. Default is frontMatter.
  • @param {string} [options.layoutProp] - The name of the property of layout pattern in a front matter. Default is 'layout'.
  • @return {Transform<Vinyl, Vinyl>}

This returns the transform stream from vinyl to vinyl. This transforms

License

MIT

Keywords

FAQs

Last updated on 08 May 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc