README

yaml-front-matter

简洁的前端解析器。前端是位于文件顶部，被 --- 包裹的 yaml 格式的元数据。

---
title: Example
---

Lorem ipsum.

use Spatie\YamlFrontMatter\YamlFrontMatter;

$object = YamlFrontMatter::parse(file_get_contents(__DIR__.'/example.md'));

$object->matter('title'); // => 'Example';
$object->body(); // => 'Lorem ipsum.'

// Or retrieve front matter with a property call...

$object->title; // => 'Example';

Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述 在这里。

支持我们

我们投入了大量资源来创建 最佳的开源包。您可以通过 购买我们的付费产品之一 来支持我们。

我们非常感激您从您的家乡寄给我们明信片，并注明您正在使用我们的哪些包。您可以在我们的 联系页面 上找到我们的地址。我们将所有收到的明信片发布在我们的 虚拟明信片墙上。

安装

您可以通过 composer 安装 yaml-front-matter

$ composer require spatie/yaml-front-matter

用法

考虑上面的 example.md 文件。首先您需要解析内容

use Spatie\YamlFrontMatter\YamlFrontMatter;
$object = YamlFrontMatter::parse(file_get_contents('example.md'));

解析器将返回一个 YamlFrontMatterObject，您可以查询前端或其正文。

$object->matter(); // => ['title' => 'Example']
$object->matter('title'); // => 'Example'
$object->body(); // => 'Lorem ipsum.'
$object->title; // => 'Example'

技巧：该 matter 函数还接受嵌套字段的点表示法，例如 matter('meta.keywords')。

变更日志

请参阅 CHANGELOG 以获取更多关于最近更改的信息。

测试

$ vendor/bin/phpunit

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全

如果您发现与安全相关的错误，请通过 [email protected] 发送邮件，而不是使用问题跟踪器。

明信片软件

您可以使用此包，但如果它进入您的生产环境，我们非常感激您从您的家乡寄给我们明信片，注明您正在使用我们的哪些包。

我们的地址是：Spatie，Kruikstraat 22，2018 安特卫普，比利时。

我们将所有收到的明信片发布在我们的 公司网站上。

鸣谢

• Sebastian De Deyne
• 所有贡献者

许可协议

MIT 许可协议（MIT）。请参阅 许可文件 以获取更多信息。