Skip to content

Commit

Permalink
Readme: synchronize
Browse files Browse the repository at this point in the history
  • Loading branch information
f3l1x committed Jul 31, 2017
1 parent 9c53ea1 commit ad824c8
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 17 deletions.
22 changes: 22 additions & 0 deletions .docs/README.md
Original file line number Diff line number Diff line change
@@ -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
```
57 changes: 40 additions & 17 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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

<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/f3l1x">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=150">
</a>
</br>
<a href="https://github.com/f3l1x">Milan Felix Šulc</a>
</td>
</tr>
<tbody>
</table>

---

Thank you for testing, reporting and contributing.

0 comments on commit ad824c8

Please sign in to comment.