MarkdownSharp.Markdown Class Reference

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). More...

Public Member Functions
	Markdown ()
	Create a new Markdown instance using default options More...
	Markdown (bool loadOptionsFromConfigFile)
	Create a new Markdown instance and optionally load options from a configuration file. There they should be stored in the appSettings section, available options are: More...
	Markdown (MarkdownOptions options)
	Create a new Markdown instance and set the options from the MarkdownOptions object. More...
string	Transform (string text)
	Transforms the provided Markdown-formatted text to HTML; see http://en.wikipedia.org/wiki/Markdown More...

Properties
string	EmptyElementSuffix [get, set]
	use ">" for HTML output, or " />" for XHTML output More...
bool	LinkEmails [get, set]
	when false, email addresses will never be auto-linked WARNING: this is a significant deviation from the markdown spec More...
bool	StrictBoldItalic [get, set]
	when true, bold and italic require non-word characters on either side WARNING: this is a significant deviation from the markdown spec More...
bool	AutoNewLines [get, set]
	when true, RETURN becomes a literal newline WARNING: this is a significant deviation from the markdown spec More...
bool	AutoHyperlink [get, set]
	when true, (most) bare plain URLs are auto-hyperlinked WARNING: this is a significant deviation from the markdown spec More...
bool	EncodeProblemUrlCharacters [get, set]
	when true, problematic URL characters like [, ], (, and so forth will be encoded WARNING: this is a significant deviation from the markdown spec More...
string	Version \`*_{}[]()>#+-.!/"\"\" [get]
	current version of MarkdownSharp; see http://code.google.com/p/markdownsharp/ for the latest code or to contribute More...

Detailed Description

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

Constructor & Destructor Documentation

MarkdownSharp.Markdown.Markdown

(

)

Create a new Markdown instance using default options

MarkdownSharp.Markdown.Markdown

(

bool

loadOptionsFromConfigFile

)

Create a new Markdown instance and optionally load options from a configuration file. There they should be stored in the appSettings section, available options are:

Markdown.StrictBoldItalic (true/false) Markdown.EmptyElementSuffix (">" or " />" without the quotes) Markdown.LinkEmails (true/false) Markdown.AutoNewLines (true/false) Markdown.AutoHyperlink (true/false) Markdown.EncodeProblemUrlCharacters (true/false)

MarkdownSharp.Markdown.Markdown

(

MarkdownOptions

options

)

Create a new Markdown instance and set the options from the MarkdownOptions object.

Member Function Documentation

string MarkdownSharp.Markdown.Transform

(

string

text

)

Transforms the provided Markdown-formatted text to HTML; see http://en.wikipedia.org/wiki/Markdown

The order in which other subs are called here is essential. Link and image substitutions need to happen before EscapeSpecialChars(), so that any *'s or _'s in the a and img tags get encoded.

Here is the caller graph for this function:

Property Documentation

bool MarkdownSharp.Markdown.AutoHyperlink

getset

when true, (most) bare plain URLs are auto-hyperlinked WARNING: this is a significant deviation from the markdown spec

bool MarkdownSharp.Markdown.AutoNewLines

getset

when true, RETURN becomes a literal newline WARNING: this is a significant deviation from the markdown spec

string MarkdownSharp.Markdown.EmptyElementSuffix

getset

use ">" for HTML output, or " />" for XHTML output

bool MarkdownSharp.Markdown.EncodeProblemUrlCharacters

getset

when true, problematic URL characters like [, ], (, and so forth will be encoded WARNING: this is a significant deviation from the markdown spec

bool MarkdownSharp.Markdown.LinkEmails

getset

when false, email addresses will never be auto-linked WARNING: this is a significant deviation from the markdown spec

bool MarkdownSharp.Markdown.StrictBoldItalic

getset

when true, bold and italic require non-word characters on either side WARNING: this is a significant deviation from the markdown spec

string MarkdownSharp.Markdown.Version \`*_{}[]()>#+-.!/"\"\"

get

current version of MarkdownSharp; see http://code.google.com/p/markdownsharp/ for the latest code or to contribute