TMarkdownWriter class

In unit WMarkDown

Markdown output writer with native Markdown formatting

Declaration

pascal

TMarkdownWriter = class(TFormattingWriter)

Inheritance

TMarkdownWriter
TFormattingWriter

Description

TMarkdownWriter generates standard Markdown output from formatted content.

Headers use # symbols (number matches level + 1), bold text uses ** delimiters, italic text uses * delimiters, and underline uses HTML <u> tags. Tables use pipe (|) separators with automatic header row underlining, lists use dash (-) bullets, and code blocks use triple backticks (```).

Special characters are escaped to prevent structural conflicts with Markdown syntax.

Methods

`Create`	public	Creates a new Markdown writer instance
`EscapeText`	public	Escapes special Markdown characters
`DocumentStart`	public	Begins document with title header
`DocumentEnd`	public	Completes document output
`HeaderStart`	public	Begins header with # symbols
`HeaderEnd`	public	Completes header with blank lines
`ParagraphStart`	public	Begins paragraph
`ParagraphEnd`	public	Completes paragraph with blank lines
`LineBreak`	public	Forces line break with trailing spaces
`Rule`	public	Writes horizontal rule
`BoldStart`	public	Begins bold formatting with double asterisks
`BoldEnd`	public	Ends bold formatting with double asterisks
`ItalicStart`	public	Begins italic formatting with single asterisk
`ItalicEnd`	public	Ends italic formatting with single asterisk
`UnderlineStart`	public	Begins underline formatting with HTML tag
`UnderlineEnd`	public	Ends underline formatting with HTML tag
`PreformatStart`	public	Begins preformatted code block
`PreformatEnd`	public	Ends preformatted code block
`TableStart`	public	Begins Markdown table with pipe separators
`TableEnd`	public	Completes table output
`RowStart`	public	Begins table row with pipe
`RowEnd`	public	Completes table row with separator line
`CellStart`	public	Begins table cell with spacing
`CellEnd`	public	Completes table cell with pipe separator
`HeaderCellStart`	public	Begins table header cell
`HeaderCellEnd`	public	Completes table header cell
`ListStart`	public	Begins list with blank line
`ListEnd`	public	Completes list with blank line
`ListItemStart`	public	Begins list item with dash bullet
`ListItemEnd`	public	Completes list item
`DefinitionItem`	public	Writes definition item with term and description

Inherited

From TFormattingWriter (11)

CellNext Dump DumpLn Header HeaderCellNext ListItem RowNext Stream Write WriteFmt WriteList

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.