Documentation

CommonMarkConverter extends MarkdownConverter
in package

Converts CommonMark-compatible Markdown to HTML.

Table of Contents

VERSION  = '1.6.7'
The currently-installed version.
$docParser  : DocParserInterface
The document parser instance.
$environment  : EnvironmentInterface
$htmlRenderer  : ElementRendererInterface
The html renderer instance.
__construct()  : mixed
Create a new commonmark converter instance.
__invoke()  : string
Converts CommonMark to HTML.
convertToHtml()  : string
Converts CommonMark to HTML.
getEnvironment()  : EnvironmentInterface

Constants

VERSION

The currently-installed version.

public mixed VERSION = '1.6.7'

This might be a typical x.y.z version, or x.y-dev.

Tags
deprecated

in 1.5.0 and will be removed from 2.0.0. Use \Composer\InstalledVersions provided by composer-runtime-api instead.

Properties

Methods

__construct()

Create a new commonmark converter instance.

public __construct([array<string, mixed> $config = [] ][, EnvironmentInterface|null $environment = null ]) : mixed
Parameters
$config : array<string, mixed> = []
$environment : EnvironmentInterface|null = null
Return values
mixed

__invoke()

Converts CommonMark to HTML.

public __invoke(string $commonMark) : string
Parameters
$commonMark : string
Tags
see
Converter::convertToHtml
throws
RuntimeException
Return values
string

convertToHtml()

Converts CommonMark to HTML.

public convertToHtml(string $commonMark) : string
Parameters
$commonMark : string
Tags
throws
RuntimeException
Return values
string

Search results