PHPackages                             shelfwood/markdown-frontmatter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. shelfwood/markdown-frontmatter

ActiveLibrary[Parsing & Serialization](/categories/parsing)

shelfwood/markdown-frontmatter
==============================

Framework-agnostic YAML frontmatter parsing for PHP

v1.0.0(4mo ago)0231MITPHPPHP ^8.2

Since Feb 12Pushed 4mo agoCompare

[ Source](https://github.com/j-shelfwood/shelfwood-markdown-frontmatter)[ Packagist](https://packagist.org/packages/shelfwood/markdown-frontmatter)[ RSS](/packages/shelfwood-markdown-frontmatter/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (2)Versions (2)Used By (1)

shelfwood/markdown-frontmatter
==============================

[](#shelfwoodmarkdown-frontmatter)

[![Tests](https://camo.githubusercontent.com/4f3f4eabebbf854fa2bf9aaa55872a677b9ecd4438f3ca7fb0fab144386ac683/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d38382532307061737365642d677265656e)](tests/)

Framework-agnostic YAML frontmatter parsing for PHP.

Installation
------------

[](#installation)

```
composer require shelfwood/markdown-frontmatter
```

Requirements
------------

[](#requirements)

- PHP 8.2+
- symfony/yaml ^7.0

Usage
-----

[](#usage)

```
use Shelfwood\MarkdownFrontmatter\Parser;

$parser = new Parser();

$content = get('title');        // 'My Document'
$tags = $result->metadata->getArray('tags');     // ['php', 'yaml']
$published = $result->metadata->getBool('published'); // true

// Access content
$markdown = $result->content;  // "# Hello World\n\nThis is the content."

// Check existence
if ($result->hasMetadata() && $result->hasContent()) {
    // Both frontmatter and content present
}
```

API
---

[](#api)

### Parser

[](#parser)

```
$parser = new Parser();

// Parse content (handles null, empty, or valid markdown)
$result = $parser->parse($content);

// Check if parser supports format (always true)
$parser->supports($content);
```

### ParsedMarkdown

[](#parsedmarkdown)

```
// Access as properties
$result->metadata;  // ContentMetadata instance
$result->content;   // string

// Or use methods
$result->getMetadata();
$result->getContent();
$result->hasMetadata();
$result->hasContent();

// Create instances
ParsedMarkdown::create(['title' => 'Test'], 'content');
ParsedMarkdown::empty();
```

### ContentMetadata

[](#contentmetadata)

```
$metadata->get('key');                    // mixed, null if missing
$metadata->get('key', 'default');         // mixed with default
$metadata->getString('key');              // string, '' if missing
$metadata->getArray('key');               // array, [] if missing
$metadata->getBool('key');                // bool, false if missing
$metadata->getInt('key');                 // int, 0 if missing
$metadata->getFloat('key');               // float, 0.0 if missing

$metadata->has('key');                    // bool
$metadata->isEmpty();                     // bool
$metadata->count();                       // int
$metadata->toArray();                     // array
```

Error Handling
--------------

[](#error-handling)

```
use Shelfwood\MarkdownFrontmatter\Exceptions\ParseException;

try {
    $result = $parser->parse($invalidYaml);
} catch (ParseException $e) {
    echo $e->getMessage();
}
```

Edge Cases
----------

[](#edge-cases)

InputResult`null`Empty ParsedMarkdownEmpty stringEmpty metadata, empty contentNo frontmatterEmpty metadata, full contentFrontmatter onlyParsed metadata, empty contentInvalid YAMLThrows ParseExceptionBOM prefixAutomatically strippedLicense
-------

[](#license)

MIT

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance74

Regular maintenance activity

Popularity9

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

142d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e09f1c5f884add18861aa69eaae3c669601e867050f35112ca6691a0c1ba6e7a?d=identicon)[j-shelfwood](/maintainers/j-shelfwood)

---

Top Contributors

[![j-shelfwood](https://avatars.githubusercontent.com/u/14902964?v=4)](https://github.com/j-shelfwood "j-shelfwood (2 commits)")

---

Tags

parseryamlmarkdownfrontmatter

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/shelfwood-markdown-frontmatter/health.svg)

```
[![Health](https://phpackages.com/badges/shelfwood-markdown-frontmatter/health.svg)](https://phpackages.com/packages/shelfwood-markdown-frontmatter)
```

###  Alternatives

[erusev/parsedown

Parser for Markdown.

15.1k156.8M869](/packages/erusev-parsedown)[league/commonmark

Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM)

3.0k437.5M1.0k](/packages/league-commonmark)[erusev/parsedown-extra

An extension of Parsedown that adds support for Markdown Extra.

84315.3M216](/packages/erusev-parsedown-extra)[rcsofttech/audit-trail-bundle

Enterprise-grade, high-performance Symfony audit trail bundle. Automatically track Doctrine entity changes with split-phase architecture, multiple transports (HTTP, Queue, Doctrine), and sensitive data masking.

1189.8k](/packages/rcsofttech-audit-trail-bundle)[parsedown/parsedown

Parser for Markdown.

221.6M9](/packages/parsedown-parsedown)[dallgoot/yaml

Provides loader, dumper and an API for YAML content. Loader builds to equivalent data types in PHP 8.x

43251.7k9](/packages/dallgoot-yaml)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)