Skip to content

Latest commit

 

History

History
118 lines (79 loc) · 5.77 KB

README.md

File metadata and controls

118 lines (79 loc) · 5.77 KB
Raw

assemble-middleware-page-variable NPM version NPM monthly downloads NPM total downloads Linux Build Status

Assemble middleware for adding a page variable to the context, with details about the current item being rendered.

Install

Install with npm:

$ npm install --save assemble-middleware-page-variable

Usage

This middleware will work with assemble, verb, generate, update or any other node.js application based on the templates library.

var pageData = require('assemble-middleware-page-variable');
var assemble = require('assemble');
var app = assemble();

app.onLoad(/\.md$/, pageData(app));
var page = app.page('home.md', {
  contents: new Buffer('---\ntitle: Home\n---\n\nThis is {{page.title}}')
});

app.render(page, function(err, view) {
  if (err) return console.log(err);
  console.log(view.contents.toString());
  //=> 'This is Home'
});

Then, inside templates you can use the variable like this:

---
title: Home
---

This is the {{page.title}} page.

Which would render to:

This is the Home page.

Custom variable

Optionally specify a custom property name to use instead of page.

// you don't need to create a custom collection too, this is just an example
app.create('posts');
app.onLoad(/\.md$/, pageData(app, 'post'));

var post = app.post('home.md', {
  contents: new Buffer('---\ntitle: Home\n---\n\nThis is {{post.title}}')
});

app.render(post, function(err, view) {
  if (err) return console.log(err);
  console.log(view.contents.toString());
  //=> 'This is Home'
});

About

Related projects

  • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
  • generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
  • templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
  • update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
  • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.3, on January 05, 2017.