parser-front-matter
Advanced tools
Readme
Front matter parsing middleware based on gray-matter.
Install with npm:
$ npm install --save parser-front-matter
This is similar to a consolidate.js engine, but for parsing. Works with assemble, verb, generate, update, express.js, parser-cache, or any application with similar conventions.
var parser = require('parser-front-matter');
Parse front matter from the given string or the contents in the given file and callback next(err, file).
If an object is passed, either file.contents or file.content
may be used (for gulp and assemble compatibility).
Params
file {String|Object}: The object or string to parse.options {Object|Function}: or next callback function. Options are passed to gray-matter.next {Function}: callback function.Example
// pass a string
parser.parse('---\ntitle: foo\n---\nbar', function (err, file) {
//=> {content: 'bar', data: {title: 'foo'}}
});
// or an object
var file = {contents: new Buffer('---\ntitle: foo\nbar')};
parser.parse(file, function(err, res) {
//=> {content: 'bar', data: {title: 'foo'}}
});
Parse front matter from the given string or the contents in the given file. If an object is passed, either file.contents or file.content may be used (for gulp and assemble compatibility).
Params
file {String|Object}: The object or string to parse.options {Object}: passed to gray-matter.Example
// pass a string
var res = parser.parseSync('---\ntitle: foo\n---\nbar');
// or an object
var file = {contents: new Buffer('---\ntitle: foo\nbar')};
var res = parser.parseSync(file);
//=> {content: 'bar', data: {title: 'foo'}}
Returned file objects have the following properties (no other properties are modified on the given file):
data: data from parsed front mattercontent: the content string, excluding front-matter (assemble compatibility)contents: the content string as a buffer, excluding front-matterorig: the original content string with front-matter includedPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 69 | jonschlinkert |
| 2 | doowb |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 16, 2017.
FAQs
Front matter parsing middleware based on gray-matter.
The npm package parser-front-matter receives a total of 51,467 weekly downloads. As such, parser-front-matter popularity was classified as popular.
We found that parser-front-matter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
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.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.