convert method Leave feedback

Converts the loaded document to Markdown using default options and returns the result with the Markdown content in ConvertResult.content.

def convert(self):
    ...

Returns: A ConvertResult whose ConvertResult.is_success indicates whether the conversion succeeded. On success, ConvertResult.content contains the Markdown string.

Converts the loaded document to Markdown and writes the output to the specified stream.

The ConvertResult.content property will be None; the Markdown bytes are written directly to output_stream.

def convert(self, output_stream):
    ...

Returns: ConvertResult: A ConvertResult indicating success or failure. On success, ConvertResult.content is None because the output was written to the stream.

Converts the loaded document to Markdown and saves the result to a file at the specified output_file_path.

def convert(self, output_file_path):
    ...

Returns: ConvertResult: A ConvertResult indicating success or failure. On success, ConvertResult.Content is None because the output was written to the file.

Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in ConvertResult.content.

def convert(self, convert_options):
    ...

Returns: A ConvertResult whose ConvertResult.content contains the Markdown string on success.

Converts the loaded document to Markdown with the specified options, writing the output to a stream.

def convert(self, output_stream, convert_options):
    ...

Returns: A ConvertResult indicating success or failure. ConvertResult.content is None because the output was written to the stream.

Converts the loaded document to Markdown with the specified options and saves the result to a file.

def convert(self, output_file_path, convert_options):
    ...

Returns: ConvertResult: A ConvertResult indicating success or failure. ConvertResult.content is None because the output was written to the file.

• class MarkdownConverter