convert_markdown method

convert_markdown

Convert Markdown source to html. Result is HTMLDocument.

Returns

Conversion result HTMLDocument.

def convert_markdown(self, source_path):
    ...
ParameterTypeDescription
source_pathstrPath to source Markdown file. It will be combined with the current directory path to form an absolute URL.

convert_markdown

Convert Markdown source to html. Result is HTMLDocument.

Returns

Conversion result HTMLDocument.

def convert_markdown(self, stream, base_uri):
    ...
ParameterTypeDescription
streamio.RawIOBaseConversion source.
base_uristrThe base URI of the document. It will be combined with the current directory path to form an absolute URL.

convert_markdown

Convert Markdown source to html. Result is HTMLDocument.

Returns

Conversion result HTMLDocument.

def convert_markdown(self, source_path, configuration):
    ...
ParameterTypeDescription
source_pathstrPath to source Markdown file. It will be combined with the current directory path to form an absolute URL.
configurationConfigurationThe environment configuration.

convert_markdown

Convert Markdown source to html. Result is html file.

def convert_markdown(self, source_path, output_path):
    ...
ParameterTypeDescription
source_pathstrPath to source Markdown file. It will be combined with the current directory path to form an absolute URL.
output_pathstrOutput file path.

convert_markdown

Convert Markdown source to html. Result is HTMLDocument.

Returns

Conversion result HTMLDocument.

def convert_markdown(self, stream, base_uri, configuration):
    ...
ParameterTypeDescription
streamio.RawIOBaseConversion source.
base_uristrThe base URI of the document. It will be combined with the current directory path to form an absolute URL.
configurationConfigurationThe environment configuration.

convert_markdown

Convert Markdown source to html. Result is html file.

def convert_markdown(self, stream, base_uri, output_path):
    ...
ParameterTypeDescription
streamio.RawIOBaseConversion source.
base_uristrThe base URI of the document. It will be combined with the current directory path to form an absolute URL.
output_pathstrOutput file path.

convert_markdown

Convert Markdown source to html. Result is html file.

def convert_markdown(self, source_path, configuration, output_path):
    ...
ParameterTypeDescription
source_pathstrPath to source Markdown file. It will be combined with the current directory path to form an absolute URL.
configurationConfigurationThe environment configuration.
output_pathstrOutput file path.

convert_markdown

Convert Markdown source to html. Result is html file.

def convert_markdown(self, stream, base_uri, configuration, output_path):
    ...
ParameterTypeDescription
streamio.RawIOBaseConversion source.
base_uristrThe base URI of the document. It will be combined with the current directory path to form an absolute URL.
configurationConfigurationThe environment configuration.
output_pathstrOutput file path.

See Also