bmx-site/docs/api/text/text_markdown.md

---

id: text.markdown title: Text.Markdown

sidebar_label: Introduction

Can either use a custom renderer, or generate HTML directly.

Types

Type	Description
TMDHtmlTocOptions	Html table of contents options.
TMarkdown	A Markdown text processor.
TMDBlock	A markdown block.
TMDBlockDoc	A markdown block document body
TMDBlockQuote	A markdown block block quote
TMDBlockUL	A markdown block unordered list
TMDBlockOL	A markdown block ordered list
TMDBlockLI	A markdown block list item
TMDBlockHR	A markdown block thematic break.
TMDBlockH	A markdown header block.
TMDBlockCode	A markdown code block.
TMDBlockHtml	A markdown HTML block.
TMDBlockP	A markdown paragraph block.
TMDBlockTable	A markdown table block.
TMDBlockTHead	A markdown table head block.
TMDBlockTBody	A markdown table body block.
TMDBlockTR	A markdown table row block.
TMDBlockTH	A markdown table header cell block
TMDBlockTD	A markdown table cell block
TMDSpan	A markdown span.
TMDSpanEM	A markdown emphasize span.
TMDSpanStrong	A markdown strong span.
TMDSpanA	A markdown hyperlink span.
TMDSpanImg	A markdown image span.
TMDSpanCode	A markdown code span.
TMDSpanDel	A markdown strikethrough span.
TMDSpanLatexMath	A markdown latex math span.
TMDSpanLatexMathDisplay	A markdown latex math display span.
TMDSpanWikiLink	A markdown wikilink span.
TMDSpanU	A markdown underline span.

Interfaces

Interface	Description
IMDRenderer	A renderer for markdown parser events.

Structs

Struct	Description
SMDAttribute	A markdown attribute.

Methods

Method Text:Int(lang:String, info:String[], text:String, output:TStringBuilder) Abstract

Provides the text for a code block.

If the code is processed, the output should be appended to output.

Returns

True if the code was processed, False if the default code block rendering should be used.