diff --git a/.docs/README.md b/.docs/README.md new file mode 100644 index 0000000..6f3e53d --- /dev/null +++ b/.docs/README.md @@ -0,0 +1,22 @@ +# Parsedown/Markdown + +## Content + +- [Usage - how to register](#usage) +- [Extension - how to configure](#configuration) + +## Usage + +```sh +composer require contributte/latte-parsedown-extra +``` + +## Configuration + +```yaml +extensions: + parsedown: Contributte\ParsedownExtra\DI\ParsedownExtraExtension + +parsedown: + helper: parsedown # Name of the helper in Latte +``` diff --git a/readme.md b/readme.md index 800dd19..8d42297 100644 --- a/readme.md +++ b/readme.md @@ -1,32 +1,55 @@ -# Latte-Parsedown-Extra +# Latte > Parsedown/Markdown -[ParsedownExtra](https://github.com/erusev/parsedown-extra) parser for Latte. +:tractor: Markdown parser to Nette Framework. ----- -[![Build Status](https://img.shields.io/travis/minetro/latte-parsedown-extra.svg?style=flat-square)](https://travis-ci.org/minetro/latte-parsedown-extra) -[![Downloads total](https://img.shields.io/packagist/dt/minetro/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/minetro/latte-parsedown-extra) -[![Latest stable](https://img.shields.io/packagist/v/minetro/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/minetro/latte-parsedown-extra) -[![HHVM Status](https://img.shields.io/hhvm/minetro/latte-parsedown-extra.svg?style=flat-square)](http://hhvm.h4cc.de/package/minetro/latte-parsedown-extra) +[![Build Status](https://img.shields.io/travis/contributte/latte-parsedown-extra.svg?style=flat-square)](https://travis-ci.org/contributte/latte-parsedown-extra) +[![Code coverage](https://img.shields.io/coveralls/contributte/latte-parsedown-extra.svg?style=flat-square)](https://coveralls.io/r/contributte/latte-parsedown-extra) +[![Licence](https://img.shields.io/packagist/l/contributte/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/contributte/latte-parsedown-extra) + +[![Downloads this Month](https://img.shields.io/packagist/dm/contributte/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/contributte/latte-parsedown-extra) +[![Downloads total](https://img.shields.io/packagist/dt/contributte/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/contributte/latte-parsedown-extra) +[![Latest stable](https://img.shields.io/packagist/v/contributte/latte-parsedown-extra.svg?style=flat-square)](https://packagist.org/packages/contributte/latte-parsedown-extra) ## Discussion / Help -[![Join the chat](https://img.shields.io/gitter/room/minetro/nette.svg?style=flat-square)](https://gitter.im/minetro/nette?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Join the chat](https://img.shields.io/gitter/room/contributte/contributte.svg?style=flat-square)](http://bit.ly/ctteg) ## Install -```sh -$ composer require minetro/latte-parsedown-extra +``` +composer require contributte/latte-parsedown-extra ``` -## Usage +## Versions -### Register in config file +| State | Version | Branch | PHP | +|-------------|----------|----------|----------| +| stable | `^1.1.0` | `master` | `>= 5.6` | -```neon -extensions: - parsedown: Minetro\ParsedownExtra\DI\ParsedownExtraExtension +## Overview -parsedown: - helper: parsedown # Name of the helper in Latte -``` + +- [Usage - how to install](https://github.com/contributte/latte-parsedown-extra/blob/master/.docs/README.md#usage) +- [Extension - how to configure](https://github.com/contributte/latte-parsedown-extra/blob/master/.docs/README.md#configuration) + +## Maintainers + + + + + + + +
+ + + +
+ Milan Felix Ć ulc +
+ +--- + +Thank you for testing, reporting and contributing.