rancoud/markdown

Markdown package

dev-master 2020-08-30 20:21 UTC

Requires

• php: >=7.4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• phpunit/phpunit: ^9.1
• squizlabs/php_codesniffer: ^3.5

MIT

• Sebastien Rancoud

README

Markdown using GitHub Flavored Markdown Spec.

Installation

composer require rancoud/markdown

How to use it?

$m = new \Rancoud\Markdown\Markdown();
echo $m->render('*my content*');

Markdown Methods

General Commands

• render(content: string):string
• addInlines(inlines: string):void
• removeInlines(inlines: string):void
• addBlocks(blocks: string):void
• removeBlocks(blocks: string):void

How to Dev

composer ci for php-cs-fixer and phpunit and coverage
composer lint for php-cs-fixer
composer test for phpunit and coverage

TODO

• test only one block rendering
• list all github examples in order