/Markdownify

The HTML to Markdown converter for PHP

Primary LanguagePHPGNU Lesser General Public License v2.1LGPL-2.1

Markdownify Build Status

The HTML to Markdown converter for PHP. See the official website

  1. Code example
  2. How to Install
  3. How to Contribute
  4. Author & Community

Code example

Markdown

$converter = new Markdownify\Converter;
$converter->parseString('<h1>Heading</h1>');
// Returns: # Heading

Markdown Extra as defined by @michelf

$converter = new Markdownify\ConverterExtra;
$converter->parseString('<h1 id="md">Heading</h1>');
// Returns: # Heading {#md}

↑ top

How to Install

If you don't have composer, you have to install it.
Add or complete the composer.json file at the root of your repository, like this :

{
    "require": {
        "pixel418/markdownify": "2.1.*"
    }
}

Markdownify can now be downloaded via composer.

↑ top

How to Contribute

  1. Fork the Markdownify repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the v2.x branch

If you don't know much about pull request, you can read the Github article.

↑ top

Author & Community

Markdownify is under LGPL License.
It was created by Milian Wolff.
It was converted to a Symfony Bundle by Peter Kruithof.
It was made accessible by composer without Symfony by Thomas ZILLIOX.

↑ top