ninjabachelor/mym-parser

从Markdown文档中解析YAML元数据

v1.0.1 2015-12-27 20:11 UTC

This package is not auto-updated.

Last update: 2024-09-14 17:53:42 UTC


README

Build Status Latest Stable Version

Markdown YAML元数据解析器。从Markdown文档中解析YAML元数据。

安装

使用以下命令安装最新版本

$ composer require ninjabachelor/mym-parser

用法

为了解析,元数据必须放在Markdown文档的开头,位于两个三横线之间。示例

---
title: Lorem ipsum dolor sit amet
author: Marcus Antonius
keywords: latin, ipsum
---

Vestibulum tortor quam, *feugiat vitae*, ultricies eget, tempor sit amet, ante.

以下是解析元数据的方法

<?php

use Ninjabachelor\MYMParser\Parser;

// Load document source.
$source = file_get_contents('document.md');

// Parse source. Result is a two-element associative array
$result = Parser::parse($source);

// The first element, 'metadata', is the array of parsed metadata. Example:
//
// array(
//     'title'     =>  'Lorem ipsum dolor sit amet',
//     'author'    =>  'Marcus Antonius',
//     'keywords'  =>  'latin, ipsum'
// );
$result['metadata'];

// The second element, 'content', is the document source without metadata. Example:
//
// Vestibulum tortor quam, *feugiat vitae*, ultricies eget, tempor sit amet, ante.
$result['content'];

许可证

MYMParser遵循MIT许可证。有关详细信息,请参阅LICENSE文件。

致谢

此库受daylerees的Kurenai启发。