Convert Markdown to DOCX – Cloud SDK and REST API

Markdown to DOCX

Aspose.HTML Cloud v4.0 provides the simplest API that you can use to convert MD documents to DOCX format with high quality easily and quickly. You may want to consider converting Markdown (MD) to DOCX because DOCX supports a wide range of formatting features, making it ideal for creating professional documents with a high level of formatting. DOCX files are widely used and compatible with many word processing applications, making editing, sharing, and collaboration easy. Additionally, conversion to DOCX allows you to integrate Markdown content into more formal and flexible document workflows.

The article provides a series of code examples demonstrating how to convert a Markdown document to DOCX using Aspose.HTML Cloud client SDKs and REST API. It covers various scenarios, including converting from a local file to a local file system and from cloud storage to cloud storage.

Examples of Markdown to DOCX Conversion

A common use case for Aspose.HTML Cloud SDK functions is file processing and conversion. The Cloud SDK enables you to retrieve an SVG document from storage by its name or from a local file on your drive, convert it to a specified format, and save it back to storage or your local drive. The following code examples demonstrate how to convert Markdown to DOCX using various SDKs and cURL for different scenarios.

Example 1. Convert Markdown to DOCX with default save options

Let’s look at an example of converting a local Markdown file to DOCX and saving the result to a local path.

The following example demonstrates the simplest way to convert Markdown to DOCX 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 Markdown to DOC
5var result = await api.ConvertAsync("test.md", "test.doc");

Java

The following example demonstrates how to convert Markdown to DOCX 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.md")
 8                .saveToLocal("output.docx");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert Markdown to DOCX C++ language applying. Local Markdown converted to DOCX 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.md";
23utility::string_t dst = w_cur_dir + L"result.docx";
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 Markdown to DOCX 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.md", output_file="test.docx")
16except ApiException as ex:
17    print("Exception")
18    print("Info: " + str(ex))
19    raise ex

PHP

The following example demonstrates how to convert Markdown to DOCX 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.md';
15$dst = 'output.docx';
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?>

Ruby

The following example demonstrates how to convert Markdown to DOCX 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.md"  # String | Full path to the input file.
19dst = "test.docx"  # 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 Markdown to DOCX Node.js language applying. Local Markdown converted to DOCX 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.md"; // {String} Source document.
19var dst = "/path/to/dst/test.docx"; // {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 Markdown to DOCX 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.md"
27let format = "docx"
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 Markdown 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 Markdown to DOCX 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.md")
 8                .saveToLocal("output.docx");
 9
10OperationResult result = api.convert(builder);

CURL

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

Upload a 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/md-doc" \
3    -d "{'InputPath': '/testpage.md', 'OutputFile': 'test.doc'}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization:Bearer <JWT_token>"

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

Example 2. Convert Markdown to DOCX inside cloud storage

Aspose.HTML Cloud allows you to get an Markdown file from your cloud storage and save conversion result back to cloud storage. The conversion occurs with default conversion options.

The following example shows how to convert Markdown to DOCX using C#. Markdown file is located in cloud storage, converted to DOCX and saved back to 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 Markdown to DOCX
5var builder = new ConverterBuilder()
6                .FromStorageFile("/test.md")
7                .ToStorageFile("/test.doc");
8                
9var result = await api.ConvertAsync(builder);

Java

The following example shows how to convert Markdown to DOCX using Java. The Markdown file is in cloud storage, convert to DOCX, and saved back to 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.md")
 8                .saveToStorage("output.docx");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert Markdown to DOCX using C++. The Markdown file is in cloud storage, convert to DOCX, and saved back to 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.md";
17utility::string_t dst = L"result/in/storage/result.docx";
18
19// Conversion
20auto result = api->convertStorageToStorage(src, dst);

Python

The following example shows how to convert Markdown to DOCX Python language applying. The Markdown file is in cloud storage, convert to DOCX, 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.md", output_file="test.docx",
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 Markdown to DOCX using PHP. The Markdown file is in cloud storage, convert to DOCX, 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.md";
15$dst = 'FolderInStorage/test.docx';
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 Markdown to DOCX Ruby language applying. The Markdown file is in cloud storage, convert to DOCX, 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.md" # String | Source file.
20dst = "FolderInStorage/test.docx" # 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 Markdown to DOCX Node.js language applying. The Markdown file is in cloud storage, convert to DOCX, 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.md"; // {String} Source document.
19var dst = "FolderInStorage/test.docx"; // {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 Markdown to DOCX Swift language applying. The Markdown file is in cloud storage, converted to DOCX, 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.md"
15let dst = "FolderInStorage/test.docx"
16
17let expectation = self.expectation(description: "testConvert to docx")
18
19HtmlAPI.convertStorageToStorage(src: src, dst: dst, storage: nil, options: nil) { (data, error) in
20
21    guard error == nil else {
22        XCTFail("Error convert Markdown to docx. 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)