API Documentation
\

\Parsedown

Summary

Methods
Properties
Constants
text()
setBreaksEnabled()
setMarkupEscaped()
setUrlsLinked()
setSafeMode()
setStrictMode()
line()
parse()
instance()
No public properties found
version
textElements()
lines()
linesElements()
extractElement()
isBlockContinuable()
isBlockCompletable()
blockCode()
blockCodeContinue()
blockCodeComplete()
blockComment()
blockCommentContinue()
blockFencedCode()
blockFencedCodeContinue()
blockFencedCodeComplete()
blockHeader()
blockList()
blockListContinue()
blockListComplete()
blockQuote()
blockQuoteContinue()
blockRule()
blockSetextHeader()
blockMarkup()
blockMarkupContinue()
blockReference()
blockTable()
blockTableContinue()
paragraph()
paragraphContinue()
lineElements()
inlineText()
inlineCode()
inlineEmailTag()
inlineEmphasis()
inlineEscapeSequence()
inlineImage()
inlineLink()
inlineMarkup()
inlineSpecialCharacter()
inlineStrikethrough()
inlineUrl()
inlineUrlTag()
unmarkedText()
handle()
handleElementRecursive()
handleElementsRecursive()
elementApplyRecursive()
elementApplyRecursiveDepthFirst()
elementsApplyRecursive()
elementsApplyRecursiveDepthFirst()
element()
elements()
li()
pregReplaceElements()
sanitiseElement()
filterUnsafeUrlInAttribute()
escape()
striAtStart()
$breaksEnabled
$markupEscaped
$urlsLinked
$safeMode
$strictMode
$safeLinksWhitelist
$BlockTypes
$unmarkedBlockTypes
$InlineTypes
$inlineMarkerList
$DefinitionData
$specialCharacters
$StrongRegex
$EmRegex
$regexHtmlAttribute
$voidElements
$textLevelElements
N/A
No private methods found
$instances
N/A

Constants

version

version

Properties

$breaksEnabled

$breaksEnabled :

Type

$markupEscaped

$markupEscaped :

Type

$urlsLinked

$urlsLinked :

Type

$safeMode

$safeMode :

Type

$strictMode

$strictMode :

Type

$safeLinksWhitelist

$safeLinksWhitelist :

Type

$BlockTypes

$BlockTypes :

Type

$unmarkedBlockTypes

$unmarkedBlockTypes :

Type

$InlineTypes

$InlineTypes :

Type

$inlineMarkerList

$inlineMarkerList :

Type

$DefinitionData

$DefinitionData :

Type

$specialCharacters

$specialCharacters :

Type

$StrongRegex

$StrongRegex :

Type

$EmRegex

$EmRegex :

Type

$regexHtmlAttribute

$regexHtmlAttribute :

Type

$voidElements

$voidElements :

Type

$textLevelElements

$textLevelElements :

Type

$instances

$instances :

Type

Methods

text()

text(  $text)

Parameters

$text

setBreaksEnabled()

setBreaksEnabled(  $breaksEnabled)

Parameters

$breaksEnabled

setMarkupEscaped()

setMarkupEscaped(  $markupEscaped)

Parameters

$markupEscaped

setUrlsLinked()

setUrlsLinked(  $urlsLinked)

Parameters

$urlsLinked

setSafeMode()

setSafeMode(  $safeMode)

Parameters

$safeMode

setStrictMode()

setStrictMode(  $strictMode)

Parameters

$strictMode

line()

line(  $text,   $nonNestables = array())

Parameters

$text
$nonNestables

parse()

parse(  $text)

Parameters

$text

instance()

instance(  $name = 'default')

Parameters

$name

textElements()

textElements(  $text)

Parameters

$text

lines()

lines(array  $lines)

Parameters

array $lines

linesElements()

linesElements(array  $lines)

Parameters

array $lines

extractElement()

extractElement(array  $Component)

Parameters

array $Component

isBlockContinuable()

isBlockContinuable(  $Type)

Parameters

$Type

isBlockCompletable()

isBlockCompletable(  $Type)

Parameters

$Type

blockCode()

blockCode(  $Line,   $Block = null)

Parameters

$Line
$Block

blockCodeContinue()

blockCodeContinue(  $Line,   $Block)

Parameters

$Line
$Block

blockCodeComplete()

blockCodeComplete(  $Block)

Parameters

$Block

blockComment()

blockComment(  $Line)

Parameters

$Line

blockCommentContinue()

blockCommentContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

blockFencedCode()

blockFencedCode(  $Line)

Parameters

$Line

blockFencedCodeContinue()

blockFencedCodeContinue(  $Line,   $Block)

Parameters

$Line
$Block

blockFencedCodeComplete()

blockFencedCodeComplete(  $Block)

Parameters

$Block

blockHeader()

blockHeader(  $Line)

Parameters

$Line

blockList()

blockList(  $Line, array  $CurrentBlock = null)

Parameters

$Line
array $CurrentBlock

blockListContinue()

blockListContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

blockListComplete()

blockListComplete(array  $Block)

Parameters

array $Block

blockQuote()

blockQuote(  $Line)

Parameters

$Line

blockQuoteContinue()

blockQuoteContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

blockRule()

blockRule(  $Line)

Parameters

$Line

blockSetextHeader()

blockSetextHeader(  $Line, array  $Block = null)

Parameters

$Line
array $Block

blockMarkup()

blockMarkup(  $Line)

Parameters

$Line

blockMarkupContinue()

blockMarkupContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

blockReference()

blockReference(  $Line)

Parameters

$Line

blockTable()

blockTable(  $Line, array  $Block = null)

Parameters

$Line
array $Block

blockTableContinue()

blockTableContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

paragraph()

paragraph(  $Line)

Parameters

$Line

paragraphContinue()

paragraphContinue(  $Line, array  $Block)

Parameters

$Line
array $Block

lineElements()

lineElements(  $text,   $nonNestables = array())

Parameters

$text
$nonNestables

inlineText()

inlineText(  $text)

Parameters

$text

inlineCode()

inlineCode(  $Excerpt)

Parameters

$Excerpt

inlineEmailTag()

inlineEmailTag(  $Excerpt)

Parameters

$Excerpt

inlineEmphasis()

inlineEmphasis(  $Excerpt)

Parameters

$Excerpt

inlineEscapeSequence()

inlineEscapeSequence(  $Excerpt)

Parameters

$Excerpt

inlineImage()

inlineImage(  $Excerpt)

Parameters

$Excerpt

inlineLink()

inlineLink(  $Excerpt)

Parameters

$Excerpt

inlineMarkup()

inlineMarkup(  $Excerpt)

Parameters

$Excerpt

inlineSpecialCharacter()

inlineSpecialCharacter(  $Excerpt)

Parameters

$Excerpt

inlineStrikethrough()

inlineStrikethrough(  $Excerpt)

Parameters

$Excerpt

inlineUrl()

inlineUrl(  $Excerpt)

Parameters

$Excerpt

inlineUrlTag()

inlineUrlTag(  $Excerpt)

Parameters

$Excerpt

unmarkedText()

unmarkedText(  $text)

Parameters

$text

handle()

handle(array  $Element)

Parameters

array $Element

handleElementRecursive()

handleElementRecursive(array  $Element)

Parameters

array $Element

handleElementsRecursive()

handleElementsRecursive(array  $Elements)

Parameters

array $Elements

elementApplyRecursive()

elementApplyRecursive(  $closure, array  $Element)

Parameters

$closure
array $Element

elementApplyRecursiveDepthFirst()

elementApplyRecursiveDepthFirst(  $closure, array  $Element)

Parameters

$closure
array $Element

elementsApplyRecursive()

elementsApplyRecursive(  $closure, array  $Elements)

Parameters

$closure
array $Elements

elementsApplyRecursiveDepthFirst()

elementsApplyRecursiveDepthFirst(  $closure, array  $Elements)

Parameters

$closure
array $Elements

element()

element(array  $Element)

Parameters

array $Element

elements()

elements(array  $Elements)

Parameters

array $Elements

li()

li(  $lines)

Parameters

$lines

pregReplaceElements()

pregReplaceElements(  $regexp,   $Elements,   $text)

Replace occurrences $regexp with $Elements in $text. Return an array of elements representing the replacement.

Parameters

$regexp
$Elements
$text

sanitiseElement()

sanitiseElement(array  $Element)

Parameters

array $Element

filterUnsafeUrlInAttribute()

filterUnsafeUrlInAttribute(array  $Element,   $attribute)

Parameters

array $Element
$attribute

escape()

escape(  $text,   $allowQuotes = false)

Parameters

$text
$allowQuotes

striAtStart()

striAtStart(  $string,   $needle)

Parameters

$string
$needle