Download the PHP package moxio/commonmark-ext-definition-list without Composer
On this page you can find all versions of the php package moxio/commonmark-ext-definition-list. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download moxio/commonmark-ext-definition-list
More information about moxio/commonmark-ext-definition-list
Files in moxio/commonmark-ext-definition-list
Package commonmark-ext-definition-list
Short Description Extension for league/commonmark to support definition lists
License MIT
Informations about the package commonmark-ext-definition-list
moxio/commonmark-ext-definition-list
Extension for the league/commonmark
Markdown parser to support definition lists.
Uses unofficial markdown syntax based on the syntax supported by PHP Markdown Extra, Pandoc and markdown-it. See the section Syntax below for details.
Requirements
This library requires PHP version 7.4 or higher and a 1.x
release of
league/commonmark
.
Installation
Install as a dependency using composer:
Usage
Add DefinitionListExtension
as an extension to your CommonMark environment
instance and you're good to go:
See the CommonMark documentation for more information about using extensions.
Syntax
The supported markdown syntax is based on the one used by
PHP Markdown Extra,
Pandoc and
markdown-it.
Since there are subtle differences between the syntaxes understood by these
libraries and there is no formally defined standard, 100% compatibility
with any of the aforementioned libraries cannot be guaranteed. The use
of the tilde (~
) as a definition list marker (as understood by Pandoc)
is also supported.
A simple example:
The will yield HTML output like:
A more complex example:
Versioning
This project adheres to Semantic Versioning.
Contributing
Contributions to this project are more than welcome. When reporting an issue, please include the input to reproduce the issue, along with the expected output. When submitting a PR, please include tests with your changes.
License
This project is released under the MIT license.
Treeware
This package is Treeware. If you use it in production, then we'd appreciate it if you buy the world a tree to thank us for our work. By contributing to the Treeware forest you'll be creating employment for local families and restoring wildlife habitats.
Made with love, coffee and fun by the Moxio team from Delft, The Netherlands. Interested in joining our awesome team? Check out our vacancies (in Dutch).