{"bugs":{"url":"https://github.com/assemble/assemble-yaml/issues"},"dist":{"shasum":"68f9073da9459de5cdb976e918b31d6bb221c39e","tarball":"https://registry.npmjs.org/assemble-yaml/-/assemble-yaml-0.1.8.tgz","integrity":"sha512-QjDqUIFE52uoTA9xGckJ0Gi+/Q7QrZcIzWET22ouLQH15MFbDlGGFSxhLvDVVDnRQZJubQE5l5DOLHVfUabTiw==","signatures":[{"sig":"MEYCIQC++QciPWUkDzOPsNf7cLPsc4M7KTafIl90eEN1befcDwIhAPejx9GGJix/a/bBVEH45TlNiyW1F3SQdZdoW3xh25rk","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"./lib","name":"assemble-yaml","_from":".","author":{"url":"https://github.com/doowb","name":"Brian Woodward"},"readme":"# assemble-yaml [![NPM version](https://badge.fury.io/js/assemble-yaml.png)](http://badge.fury.io/js/assemble-yaml)  [![Build Status](https://travis-ci.org/assemble/assemble-yaml.png)](https://travis-ci.org/assemble/assemble-yaml)\r\n\r\n> Utility library for working with YAML front matter. Works with or without Assemble.\r\n\r\nVisit [Assemble's documentation](http://assemble.io) for many more examples and pointers on getting started.\r\n\r\n## Getting Started\r\n```shell\r\nnpm install assemble-yaml --save\r\n```\r\n\r\nand use it as follows:\r\n\r\n```js\r\nvar yfm = require('assemble-yaml');\r\n```\r\n\r\n\r\n## Methods\r\n#### extract\r\nExtract YAML front matter and content from files.\r\n\r\n```js\r\nvar raw = yfm.extract(\"./file.hbs\", opts);\r\n```\r\n**Parameters**:\r\n\r\n* `String`: The file to read.\r\n* `Object`: The options object to pass to [js-yaml](https://github.com/nodeca/js-yaml)\r\n\r\n**Returns**:\r\n\r\nObject with three properties\r\n\r\n```js\r\n{\r\n \"context\": {}         // Object. YAML front matter returned as a JSON object.\r\n \"content\": \"\"         // String. File content, stripped of YAML front matter\r\n \"originalContent\": \"\" // String. Both content and YAML front matter.\r\n}\r\n```\r\n\r\n#### context\r\n\r\nReturn YAML front matter as a JSON object.\r\n\r\n```js\r\nvar data = yfm.extract(\"./file.hbs\").context;\r\n```\r\n\r\nAlias:\r\n\r\n```js\r\nvar data = yfm.extractJSON(\"./file.hbs\");\r\n```\r\n\r\n#### content\r\n\r\nReturn the content of a file, with YAML front matter removed.\r\n\r\n```js\r\nvar content = yfm.extract(\"./file.hbs\").content;\r\n```\r\n\r\nAlias:\r\n\r\n```js\r\nvar data = yfm.stripYFM(\"./file.hbs\");\r\n```\r\n\r\n\r\n\r\n## Release History\r\n\r\n * 2013-09-27   v0.1.3   Adds extractJSON and stripYFM convenience methods. Add regex to strip extraneous newlines left over after YFM is removed from a file.\r\n * 2013-09-22   v0.1.2   Adds grunt-readme and grunt-pkg-sync\r\n * 2013-08-11   v0.1.0   Initial setup - Migrated from main Assemble repo\r\n \r\n\r\n## Author\r\n\r\n+ [github.com/doowb](https://github.com/doowb)\r\n+ [twitter.com/doowb](http://twitter.com/doowb)\r\n\r\n## License\r\nCopyright (c) 2013 Brian Woodward, contributors.\r\nReleased under the MIT license\r\n\r\n***\r\n\r\n_This file was generated on Mon Sep 02 2013 09:44:51._\r\n","scripts":{"test":"grunt test"},"_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"homepage":"https://github.com/assemble/assemble-yaml","keywords":["assemble","front matter","jekyll","metadata","static site generator","yaml front matter","yaml","yfm"],"licenses":[{"url":"https://github.com/assemble/assemble-yaml/blob/master/LICENSE-MIT","type":"MIT"}],"repository":{"url":"https://github.com/assemble/assemble-yaml.git","type":"git"},"_npmVersion":"1.3.11","description":"Utility library for working with YAML front matter. Works with or without Assemble.","directories":{},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"contributors":[{"url":"https://github.com/doowb","name":"Brian Woodward"},{"url":"https://github.com/jonschlinkert","name":"Jon Schlinkert"}],"dependencies":{"to":"~0.2.9","chalk":"~0.2.1","lodash":"~1.3.1","globule":"~0.1.0","js-yaml":"~2.1.0","iconv-lite":"~0.2.11"},"readmeFilename":"README.md","devDependencies":{"chai":"~1.7.2","grunt":"~0.4.1","grunt-readme":"~0.1.3","grunt-mocha-test":"~0.6.2","grunt-contrib-watch":"~0.5.1","grunt-contrib-jshint":"~0.6.2"},"_id":"assemble-yaml@0.1.8","version":"0.1.8"}