Convert HTML to Markdown – Aspose.HTML Cloud SDK

Markdown is a markup language known for its plain text formatting syntax. Due to its readability and ease of writing, it is commonly used for documentation and README files. Initially intended for conversion to HTML, Markdown’s versatility now extends to a variety of output formats. The Aspose.HTML Cloud offers a unique feature: converting HTML back to Markdown. This feature allows users to easily access, edit, or create Markdown files from any device using any text editor, increasing flexibility and ease of content management.

Aspose.HTML Cloud provides the simplest SDK API to convert HTML documents to Markdown format with high quality, easy and fast. This article contains a set of code examples that explain how to convert HTML to Markdown using available SDKs.

Examples of HTML to Markdown Conversion

Aspose.HTML Cloud SDK allows you to fetch an HTML document from a storage location by its name, from a URL or a local file on your drive, convert it to the specified format and save the result to the storage or the local drive. The following code examples demonstrate how to convert HTML to Markdown programmatically for different cases.

Example 1. Convert HTML to Markdown with default save options

Consider an example of converting a local HTML file to Markdown and saving the result to a local path.

The following example demonstrates the simplest way to convert HTML to Markdown using C#. You can download the C# SDK from the GitHub repository.

1// Initialize SDK API
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").ConvertApi;
3
4// Convert from HTML file to Markdown file
5var result = await api.ConvertAsync("test.html", "test.md");

Java

The following example demonstrates how to convert HTML to Markdown using Java. You can download the java SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromLocalFile("input.html")
 8                .saveToLocal("output.md");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert HTML to Markdown C++ language applying. Local HTML converted to Markdown and saved to the local path.

 1// Get current directory
 2std::string cur_dir(argv[0]);
 3int pos = cur_dir.find_last_of("/\\");
 4cur_dir = cur_dir.substr(0, pos + 1); // Include the last slash
 5std::wstring w_cur_dir(cur_dir.begin(), cur_dir.end());
 6
 7const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 8const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 9const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
10const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
11
12// Create configuration for authorization
13std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
14
15// Create client from configuration
16std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
17
18// Create ConversionApi
19std::shared_ptr<ConversionApi> api = std::make_shared<ConversionApi>(apiClient);
20
21// File name for conversion
22utility::string_t src = w_cur_dir + L"test.html";
23utility::string_t dst = w_cur_dir + L"result.md";
24
25//Conversion
26auto result = api->convertLocalToLocal(src, dst);
27
28// Check the result file
29auto re = result->getFile();
30std::ifstream f(re.c_str());
31if(!f.good())
32{
33    throw std::runtime_error("Conversion failed");
34}

Python

The following example demonstrates how to convert HTML to Markdown Python language applying. You can download the Python SDK from the GitHub repository.

 1from asposehtmlcloud.configuration import Configuration
 2from asposehtmlcloud.api.html_api import HtmlApi
 3from asposehtmlcloud.api_client import ApiClient as Client
 4from asposehtmlcloud.rest import ApiException
 5
 6configuration = Configuration(apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 7                              appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 8                              basePath="https://api.aspose.cloud/v4.0",
 9                              authPath="https://api.aspose.cloud/connect/token",
10                              debug=True)
11client = Client(configuration)
12html_api = HtmlApi(client)
13
14try:
15    res = html_api.convertApi.convert_local_to_local(input_file="test.html", output_file="test.md")
16except ApiException as ex:
17    print("Exception")
18    print("Info: " + str(ex))
19    raise ex

PHP

The following example demonstrates how to convert HTML to Markdown using PHP. You can download the PHP SDK from the GitHub repository

 1<?php
 2require_once(__DIR__ . '/vendor/autoload.php');
 3
 4$conf = array(
 5	"basePath" => "https://api.aspose.cloud/v4.0",
 6	"authPath" => "https://api.aspose.cloud/connect/token",
 7	"apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8	"appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9	"defaultUserAgent" => "Webkit"
10);
11
12$api_html = new Client\Invoker\Api\HtmlApi($conf);
13
14$src = 'input.html';
15$dst = 'output.md';
16
17try {
18    // Request to server Api
19    $result = $api_html->convertLocalToLocal($src, $dst);
20    print_r($result);
21} catch (Exception $e) {
22    echo 'Exception when calling HtmlApi->convertLocalToLocal: ', $e->getMessage(), PHP_EOL;
23}
24
25?>

Ruby

The following example demonstrates how to convert HTML to Markdown Ruby language applying. You can download the Ruby SDK from the GitHub repository.

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4# Get keys from aspose site.
 5# There is free quota available. 
 6# For more details, see https://purchase.aspose.cloud/pricing
 7
 8CONFIG = {
 9    "basePath":"https://api.aspose.cloud/v4.0",
10    "authPath":"https://api.aspose.cloud/connect/token",
11    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
12    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
13    "debug":true
14}
15
16api_instance = AsposeHtml::HtmlApi.new CONFIG
17
18src = "test.html"  # String | Full path to the input file.
19dst = "test.md"    # String | Full path to the result.
20
21begin
22  #Convert the document from the local file and save result to the local file.
23  result = api_instance.convert_local_to_local(src, dst)
24  p result
25rescue AsposeHtml::ApiError => e
26  puts "Exception when calling api_instance.convert_local_to_local: #{e}"
27end

Node.js

The following example demonstrates how to convert HTML to Markdown Node.js language applying. Local HTML converted to Markdown and saved to the local path.

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Conversion Api object
16var conversionApi = new api.ConversionApi(conf);
17
18var src = "/path/to/src/test.html"; // {String} Source document.
19var dst = "/path/to/dst/test.md";  // {String} Result document.
20var opts = null;
21
22var callback = function(error, data, response) {
23  if (error) {
24    console.error(error);
25  } else {
26    console.log(data);
27  }
28};
29
30conversionApi.convertLocalToLocal(src, dst, opts, callback);

Swift

The following example demonstrates how to convert HTML to Markdown Swift language applying. You can download the Swift SDK from the GitHub repository.

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6static let fm = FileManager.default
 7let resourceDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources")
 8let resultDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/TestResult")
 9
10func url(forResource fileName: String) -> URL {
11	return resourceDir.appendingPathComponent(fileName)
12}
13
14func fileExist(name: String) -> Bool {
15	return FileManager.default.fileExists(atPath: name)
16}
17
18ClientAPI.setConfig(
19	basePath: "https://api.aspose.cloud/v4.0",
20	authPath: "https://api.aspose.cloud/connect/token",
21	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
22	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
23	debugging: true
24)
25
26let fileName = "test.html"
27let format = "md"
28let src = url(forResource: fileName).absoluteString
29
30let expectation = self.expectation(description: "testConvert to \(format)")
31let dst = resultDir.appendingPathComponent("Output.\(format)").absoluteString
32HtmlAPI.convertLocalToLocal(src: src, dst: dst, options: nil) { (data, error) in
33
34	guard error == nil else {
35		XCTFail("Error convert html to \(format)). Error=\(error!.localizedDescription)")
36		return
37	}
38	let resultPath = data!.file!
39	XCTAssertTrue(fileExist(name: resultPath))
40	expectation.fulfill()
41}
42self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

The following example demonstrates how to convert HTML to Markdown using Java/Android. You can download the Java/Android SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromLocalFile("input.html")
 8                .saveToLocal("output.md");
 9
10OperationResult result = api.convert(builder);

CURL

The following example demonstrates how to convert HTML to Markdown using REST API. Follow a few required steps:

Upload local file to storage using Storage API.
Call REST API to execute conversion (in the example below).
Download conversion result back from storage using Storage API.

1curl -X POST -v \
2	"https://api.aspose.cloud/v4.0/html/conversion/html-md" \
3    -d "{'InputPath': '/testpage.html', 'OutputFile': 'test.md'}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization:Bearer <JWT_token>"

Example 2. Convert Web page to Markdown

Aspose.HTML Cloud allows you to get a web page by its URL, convert it to another format and save into a local file system. The example below demonstrates how to convert web page to Markdown with the default conversion parameters.

The following example shows how to convert web page to Markdown using C#. HTML is taken from the Web, converted to Markdown and saved to a local file system. You can download the C# SDK from the GitHub repository.

1// Initialize SDK API
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").ConvertApi;
3
4// Convert HTML to Markdown using ConvertUrlAsync() method
5var result = await api.ConvertUrlAsync("https://example.com", "test.md");

Java

The following example shows how to convert web page to Markdown using Java. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the java SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromUrl("https://example.com")
 8                .saveToLocal("output.md");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert web page to Markdown using C++. HTML is taken from the Web, converted to Markdown and saved to the local file system.

 1// Get current directory
 2std::string cur_dir(argv[0]);
 3int pos = cur_dir.find_last_of("/\\");
 4cur_dir = cur_dir.substr(0, pos + 1); // Include the last slash
 5std::wstring w_cur_dir(cur_dir.begin(), cur_dir.end());
 6
 7const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 8const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 9const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
10const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
11
12// Create configuration for authorization
13std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
14
15// Create client from configuration
16std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
17
18// Create ConversionApi
19std::shared_ptr<ConversionApi> api = std::make_shared<ConversionApi>(apiClient);
20
21// File name for conversion
22utility::string_t src = L"https://example.com";
23utility::string_t dst = w_cur_dir + L"result.md";
24
25//Conversion
26auto result = api->convertUrlToLocal(src, dst);
27
28// Check the result file
29auto re = result->getFile();
30std::ifstream f(re.c_str());
31if(!f.good())
32{
33    throw std::runtime_error("Conversion failed");
34}

Python

The following example shows how to convert web page to Markdown Python language applying. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the Python SDK from the GitHub repository.

 1import os
 2from asposehtmlcloud.configuration import Configuration
 3from asposehtmlcloud.api.html_api import HtmlApi
 4from asposehtmlcloud.api_client import ApiClient as Client
 5from asposehtmlcloud.rest import ApiException
 6
 7# Get keys from aspose site.
 8# There is free quota available. 
 9# For more details, see https://purchase.aspose.cloud/pricing
10
11configuration = Configuration(apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
12                              appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
13                              basePath="https://api.aspose.cloud/v4.0",
14                              authPath="https://api.aspose.cloud/connect/token",
15                              debug=True)
16
17client = Client(configuration)
18html_api = HtmlApi(client)
19
20try:
21    res = html_api.convert_url_to_local(input_file="https://example.com", output_file="result.md")
22    if not os.path.exists(res.file):
23        print('conversion failed')
24except ApiException as ex:
25    print("Exception")
26    print("Info: " + str(ex))
27    raise ex

PHP

The following example demonstrates how to convert web page to Markdown using PHP. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the PHP SDK from the GitHub repository.

 1<?php
 2require_once(__DIR__ . '/vendor/autoload.php');
 3
 4$conf = array(
 5	"basePath" => "https://api.aspose.cloud/v4.0",
 6	"authPath" => "https://api.aspose.cloud/connect/token",
 7	"apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8	"appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9	"defaultUserAgent" => "Webkit"
10);
11
12$api_html = new Client\Invoker\Api\HtmlApi($conf);
13
14$src = 'https://example.com';
15$dst = 'output.md';
16
17try {
18    // Request to server Api
19    $result = $api_html->convertUrlToLocal($src, $dst);
20    print_r($result);
21} catch (Exception $e) {
22    echo 'Exception when calling HtmlApi->convertUrlToLocal: ', $e->getMessage(), PHP_EOL;
23}
24?>

Ruby

The following example shows how to convert web page to Markdown Ruby language applying. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the Ruby SDK from the GitHub repository.

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4# Get keys from aspose site.
 5# There is free quota available. 
 6# For more details, see https://purchase.aspose.cloud/pricing
 7
 8
 9CONFIG = {
10    "basePath":"https://api.aspose.cloud/v4.0",
11    "authPath":"https://api.aspose.cloud/connect/token",
12    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
14    "debug":true
15}
16
17api_instance = AsposeHtml::HtmlApi.new CONFIG
18
19src = "https://example.com"  # String | Input url.
20dst = "test.md"              # String | Result file.
21
22begin
23  #Convert the HTML file from the web and save result to the local file.
24  result = api_instance.convert_url_to_local(src, dst)
25  p result
26rescue AsposeHtml::ApiError => e
27  puts "Exception when calling api_instance.convert_url_to_local: #{e}"
28end

Node.js

The following example shows how to convert web page to Markdown Node.js language applying. HTML is taken from the Web, converted to Markdown and saved to the local file system.

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Conversion Api object
16var conversionApi = new api.ConversionApi(conf);
17
18var src = "https://example.com";   // {String} Url for conversion.
19var dst = "/path/to/dst/test.md"; // {String} Result document.
20var opts = null;
21
22var callback = function(error, data, response) {
23  if (error) {
24    console.error(error);
25  } else {
26    console.log(data);
27  }
28};
29
30conversionApi.convertUrlToLocal(src, dst, opts, callback);

Swift

The following example shows how to convert web page to Markdown Swift language applying. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the Swift SDK from the GitHub repository.

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6static let fm = FileManager.default
 7let resultDir = fm.homeDirectoryForCurrentUser.appendingPathComponent("Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/TestResult")
 8
 9func fileExist(name: String) -> Bool {
10	return FileManager.default.fileExists(atPath: name)
11}
12
13ClientAPI.setConfig(
14	basePath: "https://api.aspose.cloud/v4.0",
15	authPath: "https://api.aspose.cloud/connect/token",
16	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
17	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
18	debugging: true
19)
20
21let format = "md"
22let src = "https://example.com"
23let dst = resultDir.appendingPathComponent("Output.\(format)").absoluteString
24
25let expectation = self.expectation(description: "testConvert to \(format)")
26
27HtmlAPI.convertUrlToLocal(src: src, dst: dst, options: nil) { (data, error) in
28
29	guard error == nil else {
30		XCTFail("Error convert web site to \(format)). Error=\(error!.localizedDescription)")
31		return
32	}
33	let resultPath = data!.file!
34	XCTAssertTrue(fileExist(name: resultPath))
35	expectation.fulfill()
36}
37self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

The following example shows how to convert web page to Markdown Java/Android applying. HTML is taken from the Web, converted to Markdown and saved to the local file system. You can download the Java/Android SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromUrl("https://example.com")
 8                .saveToLocal("output.md");
 9
10OperationResult result = api.convert(builder);

CURL

The following example demonstrates how to convert web page to Markdown using REST API. HTML is taken from the Web, converted to Markdown and saved to the local file system. Follow a few required steps:

Call REST API to execute conversion (in the example below).
Download conversion result back from storage using Storage API.

1curl -X POST -v \
2	"https://api.aspose.cloud/v4.0/html/conversion/html-md" \
3    -d "{'InputPath': 'https://example.com', 'OutputFile': 'test.md'}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization:Bearer <JWT_token>"

HTML to Markdown conversion occurs with the default conversion options: the resulting MD document’s width and height correspond to A4, and all margins have zero value.

Example 3. Convert HTML to Markdown inside cloud storage

Aspose.HTML Cloud allows you to get an HTML file from your cloud storage and save conversion result back to cloud storage.

The following example shows how to convert HTML to Markdown using C#. HTML file is located in cloud storage, converted to Markdown and saved back to the cloud storage. You can download the C# SDK from the GitHub repository.

1// Initialize SDK API
2var api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET").ConvertApi;
3
4// Convert HTML to Markdown
5var builder = new ConverterBuilder()
6                .FromStorageFile("/test.html")
7                .ToStorageFile("/test.md");
8                
9var result = await api.ConvertAsync(builder);

Java

The following example shows how to convert HTML to Markdown using Java. HTML file is in cloud storage, converted to Markdown and saved back to the cloud storage. You can download the java SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromStorageFile("input.html")
 8                .saveToStorage("output.md");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert HTML to Markdown using C++. HTML file is located in cloud storage, converted to Markdown and saved back to the cloud storage.

 1const utility::string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
 2const utility::string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 3const utility::string_t basePath = L"https://api.aspose.cloud/v4.0";
 4const utility::string_t authPath = L"https://api.aspose.cloud/connect/token";
 5
 6// Create configuration for authorization
 7std::shared_ptr<ApiConfiguration> apiConfig(new ApiConfiguration(clientId, clientSecret, basePath, authPath));
 8
 9// Create client from configuration
10std::shared_ptr<ApiClient> apiClient(new ApiClient(apiConfig));
11
12// Create ConversionApi
13std::shared_ptr<ConversionApi> api = std::make_shared<ConversionApi>(apiClient);
14
15// File name for conversion
16utility::string_t src = L"file/in/storage/index.html";
17utility::string_t dst = L"result/in/storage/result.md";
18
19//Conversion
20auto result = api->convertStorageToStorage(src, dst);

Python

The following example shows how to convert HTML to Markdown Python language applying. HTML file is located in cloud storage, converted to Markdown and saved back to cloud storage. You can download the Python SDK from the GitHub repository.

 1from asposehtmlcloud.configuration import Configuration
 2from asposehtmlcloud.api.html_api import HtmlApi
 3from asposehtmlcloud.api_client import ApiClient as Client
 4from asposehtmlcloud.rest import ApiException
 5
 6configuration = Configuration(apiKey="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 7                              appSid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 8                              basePath="https://api.aspose.cloud/v4.0",
 9                              authPath="https://api.aspose.cloud/connect/token",
10                              debug=True)
11client = Client(configuration)
12html_api = HtmlApi(client)
13
14try:
15    res = html_api.convertApi.convert_storage_to_storage(input_file="test.html", output_file="test.md",
16                                                         storage_name=None)
17except ApiException as ex:
18    print("Exception")
19    print("Info: " + str(ex))
20    raise ex

PHP

The following example demonstrates how to convert HTML to Markdown using PHP. HTML file is located in cloud storage, converted to Markdown and saved back to cloud storage. You can download the PHP SDK from the GitHub repository.

 1<?php
 2require_once(__DIR__ . '/vendor/autoload.php');
 3
 4$configuration = array(
 5    "basePath" => "https://api.aspose.cloud/v4.0",
 6    "authPath" => "https://api.aspose.cloud/connect/token",
 7    "apiKey" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 8    "appSID" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 9    "defaultUserAgent" => "Webkit"
10);
11
12$api_html = new HtmlApi($configuration);
13
14$src = "FolderInStorage/test.html";
15$dst = 'FolderInStorage/test.md';
16$options = null;
17
18try {
19    $result = $api_html->convertStorageToStorage($src, $dst, null, $options);
20    print_r($result);
21} catch (Exception $e) {
22    echo 'Exception when calling $api_html->convertStorageToStorage: ', $e->getMessage(), PHP_EOL;
23}
24?>

Ruby

The following example shows how to convert HTML to Markdown Ruby language applying. HTML file is located in cloud storage, converted to Markdown and saved back to cloud storage. You can download the Ruby SDK from the GitHub repository.

 1# load the gem
 2require 'aspose_html_cloud'
 3
 4# Get keys from aspose site.
 5# There is free quota available. 
 6# For more details, see https://purchase.aspose.cloud/pricing
 7
 8
 9CONFIG = {
10    "basePath":"https://api.aspose.cloud/v4.0",
11    "authPath":"https://api.aspose.cloud/connect/token",
12    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
14    "debug":true
15}
16
17api_instance = AsposeHtml::HtmlApi.new CONFIG
18
19src = "FolderInStorage/test.html" # String | Source file.
20dst = "FolderInStorage/test.md"   # String | Result file.
21storage = nil
22
23begin
24  #Convert the file from the storage and save result to the storage.
25  result = api_instance.convert_storage_to_storage(src, dst, storage)
26  p result
27rescue AsposeHtml::ApiError => e
28  puts "Exception when calling api_instance.convert_storage_to_storage: #{e}"
29end

Node.js

The following example shows how to convert HTML to Markdown Node.js language applying. HTML file is located in cloud storage, converted to Markdown and saved back to cloud storage.

 1// Get keys from aspose site.
 2// There is free quota available.
 3// For more details, see https://purchase.aspose.cloud/pricing
 4	
 5var conf = {
 6    "basePath":"https://api.aspose.cloud/v4.0",
 7    "authPath":"https://api.aspose.cloud/connect/token",
 8    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 9    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
10    "defaultUserAgent":"NodeJsWebkit"
11};
12
13var api = require('@asposecloud/aspose-html-cloud');
14
15// Create Conversion Api object
16var conversionApi = new api.ConversionApi(conf);
17
18var src = "FolderInStorage/test.html"; // {String} Source document.
19var dst = "FolderInStorage/test.md";  // {String} Result document.
20var opts = null;
21var storage = null;
22
23var callback = function(error, data, response) {
24  if (error) {
25    console.error(error);
26  } else {
27    console.log(data);
28  }
29};
30
31conversionApi.convertStorageToStorage(src, dst, storage, opts, callback);

Swift

The following example shows how to convert HTML to Markdown Swift language applying. HTML file is in cloud storage, converted to Markdown and saved back to cloud storage. You can download the Swift SDK from the GitHub repository.

 1import Alamofire
 2import Foundation
 3import XCTest
 4import AsposeHtmlCloud
 5
 6ClientAPI.setConfig(
 7	basePath: "https://api.aspose.cloud/v4.0",
 8	authPath: "https://api.aspose.cloud/connect/token",
 9	apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10	appSID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
11	debugging: true
12)
13
14let src = "FolderInStorage/test.html"
15let dst = "FolderInStorage/test.md"
16
17let expectation = self.expectation(description: "testConvert to md")
18
19HtmlAPI.convertStorageToStorage(src: src, dst: dst, storage: nil, options: nil) { (data, error) in
20
21    guard error == nil else {
22        XCTFail("Error convert html to md. Error=\(error!.localizedDescription)")
23        return
24    }
25
26    let resultPath = data!.file!
27
28    StorageAPI.objectExists(path: resultPath, storageName: nil, versionId: nil) {(data, error) in
29        guard error == nil else {
30            XCTFail("Error objectExists exist. Error=\(error!.localizedDescription)")
31            return
32        }
33
34        XCTAssertTrue(data!.exists)
35        XCTAssertFalse(data!.isFolder)
36        expectation.fulfill()
37    }
38}
39self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

The following example shows how to convert HTML to Markdown using Java/Android. HTML file is located in cloud storage, converted to Markdown and saved back to cloud storage. You can download the Java/Android SDK from the GitHub repository.

 1Configuration.setBasePath("https://api.aspose.cloud");
 2Configuration.setAuthPath("https://api.aspose.cloud/connect/token");
 3
 4HtmlApi api = new HtmlApi("CLIENT_ID", "CLIENT_SECRET");
 5
 6JobBuilder builder = new ConverterBuilder()
 7                .fromStorageFile("input.html")
 8                .saveToStorage("output.md");
 9
10OperationResult result = api.convert(builder);

CURL

The following example demonstrates how to convert HTML to Markdown using REST API. HTML file is located in cloud storage, converted to Markdown and saved back to the cloud storage.

1curl -X POST -v \
2	"https://api.aspose.cloud/v4.0/html/conversion/html-md" \
3    -d "{'InputPath': '/test.html', 'OutputFile': '/test.md'}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization:Bearer <JWT_token>"

Convert HTML to Markdown – Aspose.HTML Cloud SDK

Examples of HTML to Markdown Conversion

Example 1. Convert HTML to Markdown with default save options

Example 2. Convert Web page to Markdown

Example 3. Convert HTML to Markdown inside cloud storage

See Also