A to the point front matter parser. Front matter is metadata written in yaml, located at the top of a file wrapped in ---
's.
---
title: Example
---
Lorem ipsum.
$object = $parser->parse(file_get_contents(__DIR__'/example.md'));
$object->matter('title'); // => 'Example';
$object->body(); // => 'Lorem ipsum.'
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
You can install the yaml-front-matter
via composer:
$ composer require spatie/yaml-front-matter
Consider the example.md
file from above. First you'll need to parse the contents:
$parser = new \Spatie\YamlFrontMatter\Parser();
$object = $parser->parse(file_get_contents('example.md'));
The parser will return a YamlFrontMatterObject
, which can be queried for front matter or it's body.
$object->matter(); // => ['title' => 'Example']
$object->matter('title'); // => 'Example'
$object->body(); // => 'Lorem ipsum.'
Protip: The matter
function also accepts dot notation for nested fields, e.g. matter('meta.keywords')
.
Please see CHANGELOG for more information what has changed recently.
$ vendor/bin/phpspec run
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
The MIT License (MIT). Please see License File for more information.