MarkdownHelper
extends Helper
in package
Markdown Helper
Provides methods for rendering Markdown content to HTML in views. Uses Parsedown for markdown parsing with XSS protection.
Usage in templates:
echo $this->Markdown->toHtml($markdownText);
Table of Contents
Properties
- $parsedown : Parsedown
- Parsedown instance for markdown parsing
Methods
- initialize() : void
- Initialize the helper and create Parsedown instance
- toHtml() : string
- Convert markdown text to HTML
- toInlineHtml() : string
- Convert markdown text to HTML (inline version, no block elements)
Properties
$parsedown
Parsedown instance for markdown parsing
protected
Parsedown
$parsedown
Methods
initialize()
Initialize the helper and create Parsedown instance
public
initialize(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration options
toHtml()
Convert markdown text to HTML
public
toHtml(string|null $markdown) : string
Parameters
- $markdown : string|null
-
The markdown text to convert
Return values
string —The HTML output
toInlineHtml()
Convert markdown text to HTML (inline version, no block elements)
public
toInlineHtml(string|null $markdown) : string
Useful for rendering markdown in contexts where block elements like paragraphs shouldn't be created.
Parameters
- $markdown : string|null
-
The markdown text to convert
Return values
string —The HTML output