icanboogie / render-engine-markdown
A Markdown render engine for icanboogie/render.
Requires
- php: >=7.2
- erusev/parsedown: ^1.6
- icanboogie/render: ^0.7|^0.8
Requires (Dev)
- icanboogie/bind-render: ^5.0
- phpunit/phpunit: ^8.5
README
A Markdown render engine for ICanBoogie/Render.
If you use the package together with ICanBoogie, the engine is registered automatically.
Installation
The recommended way to install this package is through Composer:
$ composer require icanboogie/render-engine-markdown
Cloning the repository
The package is available on GitHub, its repository can be cloned with the following command line:
$ git clone https://github.com/ICanBoogie/render-engine-markdown.git
Documentation
The package is documented as part of the ICanBoogie framework
documentation. You can generate the documentation for the package and its dependencies with
the make doc command. The documentation is generated in the build/docs directory.
ApiGen is required. The directory can later be cleaned with
the make clean command.
Testing
The test suite is ran with the make test command. PHPUnit and
Composer need to be globally available to run the suite.
The command installs dependencies as required. The make test-coverage command runs test suite
and also creates an HTML coverage report in "build/coverage". The directory can later be cleaned
with the make clean command.
The package is continuously tested by Travis CI.
License
icanboogie/render-engine-markdown is licensed under the New BSD License - See the LICENSE file for details.