Legal Notice, Privacy Policy

Impressum, Datenschutzerklärung

Cerberus X Documentation

Class Markdown

The Markdown class is used to transform text using the brl.markdown syntax. More...

Declarations

Constructors
New ( linkResolver:ILinkResolver, prettifier:IPrettifier ) Creates a new markdown object with the given link resolver.
Methods
ToHtml : String ( markdown:String ) Converts markdown to html.

Detailed Discussion

The Markdown class is used to transform text using the brl.markdown syntax.


Constructors Documentation

Method New ( linkResolver:ILinkResolver, prettifier:IPrettifier )

Creates a new markdown object with the given link resolver.

The linkResolver parameter is used by the markdown object to resolve links.

linkResolver may be null, in which case links are not resolved and will instead be converted to plain text.

The prettifier parameter is used by the markdown object to process <pre> blocks.

prettifier may be null, in which case <pre> blocks are converted to html without modification.

For a discussion of markdown syntax, please see brl.markdown.


Methods Documentation

Method ToHtml : String ( markdown:String )

Converts markdown to html.