Utilities for extracting front matter from source files.
Visit Assemble's documentation for many more examples and pointers on getting started.
npm install assemble-front-matter --save
and use it as follows:
var yfm = require('assemble-front-matter');
Extract YAML front matter and content from files.
var raw = yfm.extract("./file.hbs", opts);
Parameters:
String
: The file to read.Object
: The options object to pass to js-yaml
Returns:
Object with three properties
{
"context": {} // Object. YAML front matter returned as a JSON object.
"content": "" // String. File content, stripped of YAML front matter
"originalContent": "" // String. Both content and YAML front matter.
}
Return YAML front matter as a JSON object.
var data = yfm.extract("./file.hbs").context;
Alias:
var data = yfm.extractJSON("./file.hbs");
Return the content of a file, with YAML front matter removed.
var content = yfm.extract("./file.hbs").content;
Alias:
var data = yfm.stripYFM("./file.hbs");
- 2013-09-22 v0.1.2 Adds grunt-readme and grunt-pkg-sync
- 2013-09-02 v0.1.1 Updates tests and example files
- 2013-08-11 v0.1.0 Initial setup
Copyright (c) 2013 Brian Woodward, contributors. Released under the MIT license
This file was generated on Mon Sep 02 2013 09:44:51.