aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/pixel418/markdownify/README.md
diff options
context:
space:
mode:
authorKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2017-03-02 23:25:04 +0100
committerKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2017-03-05 01:14:15 +0100
commit6c79e0c077971029343b2dff30017571ea118438 (patch)
tree26809ee07eeee05240878bd08cfb4fdcf4bb450a /vendor/pixel418/markdownify/README.md
parent8e1716065ee01959fc799fa14ba627392a876afa (diff)
downloadvolse-hubzilla-6c79e0c077971029343b2dff30017571ea118438.tar.gz
volse-hubzilla-6c79e0c077971029343b2dff30017571ea118438.tar.bz2
volse-hubzilla-6c79e0c077971029343b2dff30017571ea118438.zip
:arrow_up: :hammer: Upgrade Markdownify library.
The current version 2.0.0 (alpha) throws deprecated warning with PHP7.1 and PHPUnit. Upgrade the HTML to Markdown converter for PHP to the current Markdownify 2.2.1. Used composer to manage this library.
Diffstat (limited to 'vendor/pixel418/markdownify/README.md')
-rw-r--r--vendor/pixel418/markdownify/README.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/vendor/pixel418/markdownify/README.md b/vendor/pixel418/markdownify/README.md
new file mode 100644
index 000000000..8855b0d05
--- /dev/null
+++ b/vendor/pixel418/markdownify/README.md
@@ -0,0 +1,63 @@
+# Markdownify
+
+[![Build Status](https://travis-ci.org/Elephant418/Markdownify.png?branch=master)](https://travis-ci.org/Elephant418/Markdownify?branch=master)
+[![Total Downloads](https://poser.pugx.org/pixel418/markdownify/downloads)](https://packagist.org/packages/pixel418/markdownify)
+[![License LGPL](https://poser.pugx.org/pixel418/markdownify/license)](https://opensource.org/licenses/lgpl-2.1.php)
+
+The HTML to Markdown converter for PHP
+
+[Code example](#code-example) | [How to Install](#how-to-install) | [How to Contribute](#how-to-contribute) | [Author & Community](#author--community)
+
+
+
+Code example
+--------
+
+### Markdown
+
+```php
+$converter = new Markdownify\Converter;
+$converter->parseString('<h1>Heading</h1>');
+// Returns: # Heading
+```
+
+### Markdown Extra [as defined by @michelf](http://michelf.ca/projects/php-markdown/extra/)
+
+```php
+$converter = new Markdownify\ConverterExtra;
+$converter->parseString('<h1 id="md">Heading</h1>');
+// Returns: # Heading {#md}
+```
+
+
+
+How to Install
+--------
+
+This library package requires `PHP 5.3` or later.<br>
+Install [Composer](http://getcomposer.org/doc/01-basic-usage.md#installation) and run the following command to get the latest version:
+
+```sh
+composer require pixel418/markdownify
+```
+
+
+
+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](https://help.github.com/articles/using-pull-requests)
+
+
+
+Author & Community
+--------
+
+Markdownify is under [LGPL License](http://opensource.org/licenses/LGPL-2.1)<br>
+It was created by [Milian Wolff](http://milianw.de)<br>
+It was converted to a Symfony Bundle by [Peter Kruithof](https://github.com/pkruithof)<br>
+It is maintained by [Thomas ZILLIOX](http://tzi.fr)