html2md Namespace Reference

html2md namespace More...

Classes
class	Converter
	Class for converting HTML to Markdown. More...
struct	Options
	Options for the conversion from HTML to Markdown. More...

Functions
std::string	Convert (std::string &html, bool *ok=nullptr)
	Static wrapper around the Converter class.
std::string	Convert (std::string &&html, bool *ok=nullptr)

Detailed Description

html2md namespace

The html2md namespace provides:

1. The Converter class
2. Static wrapper around Converter class

Note

Do NOT try to convert HTML that contains a list in an ordered list or a blockquote in a list!
This will be a total mess!

Function Documentation

Convert() [1/2]

std::string html2md::Convert ( std::string && html, bool * ok = nullptr )

inline

Definition at line 606 of file html2md.h.

Convert() [2/2]

std::string html2md::Convert ( std::string & html, bool * ok = nullptr )

inline

Static wrapper around the Converter class.

Parameters

html	The HTML passed to Converter
ok	Optional: Pass a reference to a local bool to store the output of Converter::ok()

Returns

Returns the by Converter generated Markdown

Definition at line 597 of file html2md.h.