Html2Markdown.Converter Class Reference

An HTML to Markdown converter. More...

Public Member Functions
	Converter ()
	Initialises a new instance of the Converter class with the default conversion options.
	Converter (ConverterOptions options)
	Initialises a new instance of the Converter class.
string	ConvertFile (string path)
	Converts HTML contained in a file to a Markdown string.
string	Convert (string html)
	Converts an HTML string to a Markdown string.

Detailed Description

An HTML to Markdown converter.

Constructor & Destructor Documentation

Converter() [1/2]

Html2Markdown.Converter.Converter ( )

inline

Initialises a new instance of the Converter class with the default conversion options.

Converter() [2/2]

Html2Markdown.Converter.Converter ( ConverterOptions  options )

inline

Initialises a new instance of the Converter class.

Parameters

options

The options used to configure conversion.

Member Function Documentation

Convert()

string Html2Markdown.Converter.Convert ( string  html )

inline

Converts an HTML string to a Markdown string.

Parameters

html	The HTML string you wish to convert

Returns

A Markdown representation of the passed in HTML

ConvertFile()

string Html2Markdown.Converter.ConvertFile ( string  path )

inline

Converts HTML contained in a file to a Markdown string.

Parameters

path	The path to the file which is being converted

Returns

A Markdown representation of the passed in HTML

---

The documentation for this class was generated from the following file:

• src/Html2Markdown/Converter.cs