README

Markup

---- One interface to multiple markdown parsers.

Synopsis
--------
This library provides a unified interface to several markdown implementations.
Popular implementations are already included with the library.

Copyright & License
-------------------
Markup is Copyright (c) 2012 David Persson
if not otherwise stated. The code is distributed under the terms
of the MIT License. For the full license text see the LICENSE file.

3rd Party Libraries
-------------------
The `lib` directory contains all 3rd party libraries.

Please note that only those libraries are listed here that are used as direct
dependencies. Libraries the 3rd party libraries depend on are not listed. For
information on those see the README of the respective 3rd party library. When
present the full license text of each library has been amended to the LICENSE
file.

Path                              Copyright Holder              License        Mod.
...................................................................................
lib/markdown_extra.php            John Gruber, Michel Fortin    BSD-3-clause   no
lib/markdown_extra_extended.php   John Gruber, Michel Fortin,   BSD-3-clause   yes
                                  Egil Hansen
lib/smartypants.php               John Gruber, Michel Fortin    BSD-3-clause   no

All modifications to 3rd party libraries are documented in the form of version
controlled changes. Please consult the version history for changes to the
relevant files.

Requirements
------------
PHP >=5.4.0 is required to run the code.

Installation
------------
composer require davidpersson/markup

Usage
-----
<?php

use markup\Markdown;

$html = Markdown::parse('...markdown...');

// Reconfigure the steps to pass content through
// for all subsequent parsing.
Markdown::config([
	'normalize',
	'markdownExtra'
]);

// Or provide the steps ad hoc.
$html = Markdown::parse('...markdown...', [
	'normalize',
	'markdownExtra'
]);

?>