Documentation

MarkdownRenderer
in package

FinalYes

Centralized Markdown rendering for events, articles, and other content.

Uses Parsedown with safe mode enabled to prevent XSS. Reusable across the application for consistent Markdown-to-HTML conversion.

Table of Contents

Properties

$parsedown  : Parsedown|null

Methods

toHtml()  : string
Convert Markdown string to safe HTML.
toPlainPreview()  : string
Get a plain-text preview (no Markdown, no HTML) for lists/previews.
getParser()  : Parsedown
Get or create the Parsedown instance (singleton)

Properties

Methods

toHtml()

Convert Markdown string to safe HTML.

public static toHtml(string|null $markdown) : string
Parameters
$markdown : string|null

Raw Markdown content (null treated as empty)

Return values
string

Rendered HTML (safe, escaped via Parsedown safe mode)

toPlainPreview()

Get a plain-text preview (no Markdown, no HTML) for lists/previews.

public static toPlainPreview(string|null $markdown[, int $maxLength = 150 ]) : string
Parameters
$markdown : string|null

Raw Markdown content

$maxLength : int = 150

Maximum length before truncation

Return values
string

Plain text preview

getParser()

Get or create the Parsedown instance (singleton)

private static getParser() : Parsedown
Return values
Parsedown

Parser with safe mode enabled


        
On this page

Search results