Skip to content

Commit

Permalink
📝 Update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Molkobain committed Aug 18, 2020
1 parent 5b99f00 commit 1a86cc0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

## [1.3.0] - 2020-08-18
### Added
- Add possibility to choose Mardown converter options

## [1.2.0] - 2019-12-31
### Changed
- Fix display in the admin. console
Expand Down Expand Up @@ -33,7 +37,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
### Added
- First version

[Unreleased]: https://github.com/Molkobain/itop-markdown-viewer/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/Molkobain/itop-markdown-viewer/compare/v1.3.0...HEAD
[1.3.0]: https://github.com/Molkobain/itop-markdown-viewer/releases/tag/v1.3.0
[1.2.0]: https://github.com/Molkobain/itop-markdown-viewer/releases/tag/v1.2.0
[1.1.3]: https://github.com/Molkobain/itop-markdown-viewer/releases/tag/v1.1.3
[1.1.2]: https://github.com/Molkobain/itop-markdown-viewer/releases/tag/v1.1.2
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Out of the box this extension doesn't change any attributes, you have to configu
Some configuration parameters are available from the Configuration editor of the console:
* ``enabled`` Enable / disable the extension without having to uninstall it. Value can be ``true`` or ``false``.
* ``markdown_attributes`` Class attributes to enable as Markdown. Value must be an array of classes, each containing an array of the attributes you want to render as Markdown. Default value is none, you have to set which ones you want!
* ``markdown_options`` Allow to set the options of the Markdown converter ([Showdown.js](https://github.com/showdownjs/showdown)), check the dedicated [wiki page](https://github.com/showdownjs/showdown) to see them all.

*Example:*
```
Expand All @@ -73,6 +74,9 @@ Some configuration parameters are available from the Configuration editor of the
'ServiceSubcategory' => array('description'),
'FAQ' => array('summary', 'description'),
),
'markdown_options' => array(
'tables' => true,
),
),
```

Expand Down

0 comments on commit 1a86cc0

Please sign in to comment.