laravie/kurenai

Markdown document parser with metadata.

v2.0.0 2018-05-06 14:58 UTC

Requires

• php: >=7.1
• symfony/yaml: ^3.0 || ^4.0

Requires (Dev)

• erusev/parsedown: ^1.7.1
• erusev/parsedown-extra: ~0.7
• league/commonmark: ~0.17
• mockery/mockery: ^1.0
• phpunit/phpunit: ^7.0

Suggests

• erusev/parsedown: Parsing markdown using erusev/parsedown (^1.7.1).
• erusev/parsedown-extra: Parsing markdown using erusev/parsedown-extra (~0.7).
• league/commonmark: Parsing markdown using league/commonmark (~0.17).

Conflicts

• daylerees/kurenai: ~1.0

MIT

• Mior Muhammad Zaki
• Dayle Rees

• metadata
• markdown
• document
• kurenai

README

Kurenai is a Markdown document parser which allows for extra metadata to be associated with the document.

Introduction

Confused? Let's take a look at how it works.

This is what your documents might look like:

title: This is my document title.
slug: this-is-the-slug
date: 12th December 1984
-------
This is my **markdown** content!

and here is how you will parse it with Kurenai :

<?php

// Use the Kurenai document parser.
use Kurenai\Document;
use Kurenai\DocumentParser;
use Kurenai\Parser\Parsedown;

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

// Create a new document parser
$parser = new DocumentParser(new Document(new Parsedown));

// Parse the loaded source.
$document = $parser->parse($source);

// To get the document content in raw markdown format..
// This is my **markdown** content!
$rawMarkdown = $document->getContent();

// To get the converted HTML content..
// <p>This is my <strong>markdown</strong> content!</p>
$html = $document->getHtmlContent();

// To access the full array of metadata
// array(
//      'title'     => 'This is my document title.',
//      'slug'      => 'this-is-the-slug',
//      'date'      => '12th December 1984'
// );
$metadata = $document->get();

// To access a piece of metadata by key (default: null)..
// this-is-the-slug
$slug = $document->get('slug');

Origin

Kurenai is a forked project from daylerees/kurenai.