README

PHP的YAML前端内容的实现。它可以解析YAML和Markdown。

安装

使用Composer安装项目

composer require mnapoli/front-yaml

$parser = new Mni\FrontYAML\Parser;

$document = $parser->parse($str);

$yaml = $document->getYAML();
$html = $document->getContent();

如果您不想解析Markdown（可能因为它不是Markdown）

$document = $parser->parse($str, false);

以下文件

---
foo: bar
---
This is **strong**.

将给出

var_export($document->getYAML());
// array("foo" => "bar")

var_export($document->getContent());
// "<p>This is <strong>strong</strong></p>"

$parser = new Mni\FrontYAML\Parser($yamlParser, $markdownParser);

此库使用依赖注入和抽象，允许您提供自己的YAML或Markdown解析器。

interface YAMLParser
{
    public function parse($yaml);
}

默认情况下，FrontYAML使用 Symfony的YAML解析器。

interface MarkdownParser
{
    public function parse($markdown);
}

默认情况下，FrontYAML使用 League CommonMark解析器。