json-front-matter
Extract JSON front matter from strings and files in the style of Jekyll's YAML Front Matter.
Installing
npm install json-front-matter
Methods
parse( s )
Parses strings
, returning an object with propertiesattributes
, containing the JSON front matter, andbody
containing the rest.parseFile( path, callback( err, data ))
Parses file atpath
, calling the callback upon completion withdata
object containingattributes
andbody
, like the string parse method.
Usage
var fm = ; var string = '{{{ "title" : "some title", "array" : [ 1, 2, 3 ] }}} bodybodybody';var out = fm; console // 'bodybodybody'console // 'some title'console // [ 1, 2, 3 ]
File Example
See ./tests/data/test.md for example of JSON Front Matter in a markdown file. The outer JSON is encapsulated via triple curly brackets. {{{ "tags" : [ 'rock', 'paper', 'scissors' ] }}}
Testing
Run node tests/runTests.js
from project root -- testing uses nodeunit
License
MIT License, Copyright (c) 2012 Jordan Santell