PHPackages                             daylerees/kurenai - 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. [PDF & Document Generation](/categories/documents)
4. /
5. daylerees/kurenai

ActiveLibrary[PDF & Document Generation](/categories/documents)

daylerees/kurenai
=================

Multi document parser with metadata support.

2.1.0(7y ago)15211.7k—0%12[3 issues](https://github.com/daylerees/kurenai/issues)[2 PRs](https://github.com/daylerees/kurenai/pulls)MITPHPPHP >=5.6.5CI failing

Since Mar 16Pushed 4y ago7 watchersCompare

[ Source](https://github.com/daylerees/kurenai)[ Packagist](https://packagist.org/packages/daylerees/kurenai)[ RSS](/packages/daylerees-kurenai/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (6)Dependencies (10)Versions (10)Used By (0)

[![Kurenai](kurenai.png)](https://github.com/daylerees/kurenai)

Kurenai
=======

[](#kurenai)

[![Build Status](https://camo.githubusercontent.com/21d9240a082238fc32e7f1b947d1b22f5d6c1821c8ea82116cd07f1d131c3226/68747470733a2f2f7472617669732d63692e6f72672f6461796c65726565732f6b7572656e61692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/daylerees/kurenai)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/5faae6d9606496a7b885f4f13356b0733ce356a800956df6f023ff76e638909c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6461796c65726565732f6b7572656e61692f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/daylerees/kurenai/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/a325db2515329b9e8550ce4d3de2c057d55425cc8c23f828ffe6426a8c3b4952/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6461796c65726565732f6b7572656e61692f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/daylerees/kurenai/?branch=master)[![Code Climate](https://camo.githubusercontent.com/8b3adb22b2256016b12ea15952076979bd1988dfeafe3b6b27bc9738c04e2f84/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6461796c65726565732f6b7572656e61692f6261646765732f6770612e737667)](https://codeclimate.com/github/daylerees/kurenai)[![HHVM Tested](https://camo.githubusercontent.com/5effc7de619c1bc758aa9f909233e402ee0307be9cbb03c2e290e3d41a0946f5/68747470733a2f2f696d672e736869656c64732e696f2f6868766d2f6461796c65726565732f6b7572656e61692e737667)](https://travis-ci.org/daylerees/kurenai)

[![Packagist Version](https://camo.githubusercontent.com/9ae0b03bfe469940af9c3958011bb647ff33102a147fd3780e02f8459aacdf97/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6461796c65726565732f6b7572656e61692e737667)](https://packagist.org/packages/daylerees/kurenai)[![Packagist](https://camo.githubusercontent.com/add8bb898c9fece513a1198481e9bba61a6090cdd426e7fe5b534586ab35cd83/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6461796c65726565732f6b7572656e61692e737667)](https://packagist.org/packages/daylerees/kurenai)

Kurenai is a document with metadata parsing library for PHP. It supports a variety of different document content and metadata parsers.

---

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

[](#installation)

Kurenai is available on [Packagist](https://packagist.org/packages/daylerees/kurenai) for [Composer](https://getcomposer.org/).

```
composer require daylerees/kurenai

```

Usage
-----

[](#usage)

Kurenai documents look like this:

```
Some form of metadata here.
===
Some form of content here.

```

A metadata section, and a content section seperated by three equals `===` signs or more.

Here's an example using JSON for metadata, and Markdown for content.

```
{
    "title": "Hello world!"
}
===
# Hello World

Well hello there, world!

```

Formats for metadata and content are interchangable using classes called parsers. First, let's create our parser instance.

```
$kurenai = new \Kurenai\Parser(
    new \Kurenai\Parsers\Metadata\JsonParser,
    new \Kurenai\Parsers\Content\MarkdownParser
);
```

In the above example, we're using a JSON metadata parser, and a Markdown content parser. We can now parse a document.

```
$document = $kurenai->parse('path/to/document.md');
```

Our documents can have any filename or extension. You can also pass the `parse()` function the content of a document directly.

The document instance has a few useful methods.

```
$document->getRaw();
```

This will fetch the raw document content. Before Kurenai parsed it.

```
$document->getMetadata();
```

This will fetch the metadata, parsed into an array.

```
$document->getContent();
```

This will get the content of the document, rendered using the provided content parser.

```
$document->get('foo.bar');
```

The `get()` method uses dot-notation to return a metadata value. For example, the above example would be equivalent to fetching `$metadata['foo']['bar']`.

If the subject can't be found, `null` will be returned. You can supply a default value as a second parameter to the method.

Metadata Parsers
----------------

[](#metadata-parsers)

FormatInstall PackageClassJSONN/A`Kurenai\Parsers\Metdata\JsonParser`YAML`symfony/yaml``Kurenai\Parsers\Metdata\YamlParser`ININ/A`Kurenai\Parsers\Metdata\IniParser`Content Parsers
---------------

[](#content-parsers)

FormatInstall PackageClassPlaintext (no parsing)N/A`Kurenai\Parsers\Content\PlainTextParser`CommonMark`league/commonmark``Kurenai\Parsers\Content\CommonMarkParser`Markdown`michelf/php-markdown``Kurenai\Parsers\Content\MarkdownParser`Markdown Extra`michelf/php-markdown``Kurenai\Parsers\Content\MarkdownExtraParser`Parsedown (Github Markdown)`erusev/parsedown``Kurenai\Parsers\Content\ParsedownParser`Textile`netcarver/textile``Kurenai\Parsers\Content\TextileParser`Enjoy using Kurenai!

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity38

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 53.1% 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

Every ~325 days

Recently: every ~424 days

Total

7

Last Release

2854d ago

Major Versions

1.1.0 → 2.0.02016-02-07

### Community

Maintainers

![](https://www.gravatar.com/avatar/5df33ae838a2ae1bf42eda2f083df8cf63bdc3634b8c728d9acc883e72f62248?d=identicon)[daylerees](/maintainers/daylerees)

---

Top Contributors

[![daylerees](https://avatars.githubusercontent.com/u/207870?v=4)](https://github.com/daylerees "daylerees (26 commits)")[![driesvints](https://avatars.githubusercontent.com/u/594614?v=4)](https://github.com/driesvints "driesvints (6 commits)")[![crynobone](https://avatars.githubusercontent.com/u/172966?v=4)](https://github.com/crynobone "crynobone (6 commits)")[![alexsoft](https://avatars.githubusercontent.com/u/1451894?v=4)](https://github.com/alexsoft "alexsoft (3 commits)")[![trq](https://avatars.githubusercontent.com/u/32683?v=4)](https://github.com/trq "trq (3 commits)")[![orthographic-pedant](https://avatars.githubusercontent.com/u/14522744?v=4)](https://github.com/orthographic-pedant "orthographic-pedant (2 commits)")[![jessiesiat](https://avatars.githubusercontent.com/u/1209970?v=4)](https://github.com/jessiesiat "jessiesiat (1 commits)")[![rgomezcasas](https://avatars.githubusercontent.com/u/1331435?v=4)](https://github.com/rgomezcasas "rgomezcasas (1 commits)")[![hirenkeraliya](https://avatars.githubusercontent.com/u/22992703?v=4)](https://github.com/hirenkeraliya "hirenkeraliya (1 commits)")

---

Tags

metadatamarkdowndocumentkurenaidaylerees

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/daylerees-kurenai/health.svg)

```
[![Health](https://phpackages.com/badges/daylerees-kurenai/health.svg)](https://phpackages.com/packages/daylerees-kurenai)
```

###  Alternatives

[tecnickcom/tc-lib-pdf

PHP PDF Library

1.8k452.3k7](/packages/tecnickcom-tc-lib-pdf)[gotenberg/gotenberg-php

A PHP client for interacting with Gotenberg, a developer-friendly API for converting numerous document formats into PDF files, and more!

3685.2M19](/packages/gotenberg-gotenberg-php)[faisalman/simple-excel-php

Easily parse / convert / write between Microsoft Excel XML / CSV / TSV / HTML / JSON / etc formats

582599.4k1](/packages/faisalman-simple-excel-php)[stevebauman/autodoc-facades

Auto-generate PHP doc annotations for Laravel facades

98186.6k9](/packages/stevebauman-autodoc-facades)[netcarver/textile

Textile markup language parser

2311.5M16](/packages/netcarver-textile)[themsaid/ibis

Markdown to PDF book builder

2.0k2.0k](/packages/themsaid-ibis)

PHPackages © 2026

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