Convert Markdown to PDF – Cloud SDKs and REST API

Markdown to PDF

PDF is a static document format that supports text, images, form fields, media, digital signatures, hyperlinks, etc. Converting Markdown to PDF preserves document formatting and ensures consistent display across different devices and platforms. PDF is widely supported and provides a reliable format for sharing and archiving documents while retaining the original layout and styling of the Markdown content. PDFs’ extensive interoperability and security features enhance document sharing and protection of sensitive information.

Aspose.HTML Cloud v4.0 provides the simplest API to convert MD documents to PDF format with high quality, easy and fast.

The article details a series of code examples demonstrating the conversion of a Markdown document to PDF using Aspose.HTML Cloud client SDKs and REST API. SDKs are available in PHP, C++, Python, C#, Ruby, Java, Android, Swift, and Node.js. Various conversion scenarios are covered:

Converting a local Markdown file to PDF and saving the result in the local file system. This includes exploring conversions with both default and explicitly specified parameters.
Converting Markdown to PDF directly in cloud storage using default conversion parameters.

Examples of Markdown to PDF Conversion

A common use case for Aspose.HTML Cloud SDK functions is file processing and conversion. The Cloud SDK enables you to retrieve an Markdown 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 PDF using various SDKs and cURL for different scenarios.

Example 1. Convert Markdown to PDF with default save options

Let’s look at an example of converting a local Markdown file to PDF and saving the result to a local file system. The conversion occurs with default conversion options.

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

Java

The following example demonstrates how to convert Markdown to PDF 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.pdf");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert Markdown to PDF C++ language applying. Local Markdown converted to PDF 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.pdf";
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 PDF 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.pdf")
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 PDF 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.pdf';
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 Markdown to PDF 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.pdf"   # 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 PDF Node.js language applying. Local Markdown converted to PDF 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.pdf"; // {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 PDF 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 = "pdf"
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 PDF 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.pdf");
 9
10OperationResult result = api.convert(builder);

CURL

The following example demonstrates how to convert Markdown to PDF 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-pdf" \
3    -d "{'InputPath': '/testpage.md', 'OutputFile': 'test.pdf'}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization:Bearer <JWT_token>"

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

Example 2. Convert Markdown to PDF with explicitly specified options

The example below demonstrates how to convert an Markdown file from a local file system to PDF with explicitly specified options and save the result back to the local file system.

The following SDK example demonstrates how to convert Markdown to PDF 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// Create an options object and specify options for Markdown to PDF conversion
 5var options = new PDFConversionOptions()
 6                .SetHeight(8.3)
 7                .SetWidth(11.7)
 8                .SetLeftMargin(0.5)
 9                .SetRightMargin(0.5)
10                .SetBottomMargin(0.5)
11                .SetTopMargin(0.5);
12
13// Convert Markdown file to PDF format
14var result = await api.ConvertAsync("test.md", "test.pdf", options);

Java

The following example demonstrates how to convert Markdown to PDF 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
 6PDFConversionOptions opt_A5 = new PDFConversionOptions()
 7                    .setWidth(5.8)        // A5 format in inches
 8                    .setHeight(8.3)
 9                    .setTopMargin(0.5)
10                    .setBottomMargin(0.5)
11                    .setLeftMargin(0.5)
12                    .setRightMargin(0.5)
13                    .setQuality(95);
14
15JobBuilder builder = new ConverterBuilder()
16                .fromLocalFile("input.md")
17                .useOptions(opt_A5)
18                .saveToLocal("output.pdf");
19
20OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert Markdown to PDF using C++. Markdown is taken from a local file system, converted to PDF and saved to the local drive.

 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.pdf";
24
25std::shared_ptr<ConversionOptions> opts = std::make_shared<ConversionOptions>();
26opts->setWidth(8.3)
27    ->setHeight(11.7)
28    ->setLeftMargin(0.2)
29    ->setRightMargin(0.2)
30    ->setTopMargin(0.2)
31    ->setBottomMargin(0.2);
32
33// Conversion
34auto result = api->convertLocalToLocal(src, dst, opts);
35
36// Check the result file
37auto re = result->getFile();
38std::ifstream f(re.c_str());
39if(!f.good())
40{
41    throw std::runtime_error("Conversion failed");
42}

Python

The following example demonstrates how to convert Markdown to PDF 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
14options = {
15    'width': 8.3,
16    'height': 11.7,
17    'topmargin': 0.2,
18    'bottommargin': 0.2,
19    'leftmargin': 0.2,
20    'rightmargin': 0.2
21}
22
23try:
24    res = html_api.convertApi.convert_local_to_local(input_file="test.md", output_file="test.pdf", options=options)
25except ApiException as ex:
26    print("Exception")
27    print("Info: " + str(ex))
28    raise ex

PHP

The following example demonstrates how to convert Markdown to PDF 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.pdf';
16
17$options_a4 = [
18    'width' => 8.3,
19    'height' => 11.7,
20    'left_margin' => 0.2,
21    'right_margin' => 0.2,
22    'top_margin' => 0.2,
23    'bottom_margin' => 0.2
24];
25
26
27try {
28    // Request to server Api
29    $result = $api_html->convertLocalToLocal($src, $dst, $options_a4);
30    print_r($result);
31} catch (Exception $e) {
32    echo 'Exception when calling HtmlApi->convertLocalToLocal: ', $e->getMessage(), PHP_EOL;
33}
34?>

Ruby

The following example demonstrates how to convert Markdown to PDF 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
 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 = "test.md" # String | Source file.
20dst = "test.pdf" # String | Result file.
21
22opts = { 
23  width: 8.3,        # Float | Resulting document width in inches.
24  height: 11.7,      # Float | Resulting document height in inches.
25  left_margin: 0.2,  # Float | Left resulting document margin in inches.
26  right_margin: 0.2, # Float | Right resulting document margin in inches.
27  top_margin: 0.2,   # Float | Top resulting document margin in inches.
28  bottom_margin: 0.2 # Float | Bottom resulting document margin in inches.
29}
30
31begin
32  #Convert the HTML file from the local file and save result to the local file.
33  result = api_instance.convert_local_to_local(src, dst, opts)
34  p result
35rescue AsposeHtml::ApiError => e
36  puts "Exception when calling api_instance.convert_local_to_local: #{e}"
37end

Node.js

The following example demonstrates how to convert Markdown to PDF Node.js language applying.

 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.pdf"; // {String} Result document.
20var opts = {
21    'width': 8.3,
22    'height': 11.7,
23    'leftMargin': 0.2,
24    'rightMargin': 0.2,
25    'topMargin': 0.2,
26    'bottomMargin': 0.2
27};
28
29var callback = function(error, data, response) {
30  if (error) {
31    console.error(error);
32  } else {
33    console.log(data);
34  }
35};
36
37conversionApi.convertLocalToLocal(src, dst, opts, callback);

Swift

The following example demonstrates how to convert Markdown to PDF 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 = "pdf"
28let src = url(forResource: fileName).absoluteString
29let options = Options(width: 8.3, height: 11.7, leftMargin: 0.2,
30        rightMargin: 0.2, topMargin: 0.2, bottomMargin: 0.2)
31
32
33let expectation = self.expectation(description: "testConvert to \(format)")
34let dst = resultDir.appendingPathComponent("Output.\(format)").absoluteString
35HtmlAPI.convertLocalToLocal(src: src, dst: dst, options: options) { (data, error) in
36
37	guard error == nil else {
38		XCTFail("Error convert Markdown to \(format)). Error=\(error!.localizedDescription)")
39		return
40	}
41	let resultPath = data!.file!
42	XCTAssertTrue(fileExist(name: resultPath))
43	expectation.fulfill()
44}
45self.waitForExpectations(timeout: 100.0, handler: nil)

Java/Android

The following example demonstrates how to convert Markdown to PDF using Java/Android. Markdown is taken from a local file system, converted to PDF and saved to the local drive. 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
 6PDFConversionOptions opt_A5 = new PDFConversionOptions()
 7                    .setWidth(5.8)        // A5 format in inches
 8                    .setHeight(8.3)
 9                    .setTopMargin(0.5)
10                    .setBottomMargin(0.5)
11                    .setLeftMargin(0.5)
12                    .setRightMargin(0.5)
13                    .setQuality(95);
14
15JobBuilder builder = new ConverterBuilder()
16                .fromLocalFile("input.md")
17                .useOptions(opt_A5)
18                .saveToLocal("output.pdf");
19
20OperationResult result = api.convert(builder);

CURL

The following example demonstrates how to convert Markdown to PDF using REST API. Local Markdown converted to PDF and saved to the local file system. Follow a few required steps:

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

1curl -X POST -v \
2	"https://api.aspose.cloud/v4.0/html/conversion/md-pdf" \
3    -d "{'InputPath': '/testpage.md', 'OutputFile': 'test.pdf', 'Options': {'Width':1000, 'Height': 800, 'LeftMargin': 10, 'RightMargin': 10, 'TopMargin': 10, 'BottomMargin': 10}}" \
4    -H "Content-Type: application/json" \
5    -H "Authorization: bearer <token>"

More details about available conversion parameters for Markdown files are in the SDK Conversion Options section.

Example 3. Convert Markdown to PDF 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 PDF using C#. Markdown file is located in cloud storage, converted to PDF 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 PDF using ConvertAsync() method
5var builder = new ConverterBuilder()
6                .FromStorageFile("/test.md")
7                .ToStorageFile("/test.pdf");
8                
9var result = await api.ConvertAsync(builder);

Java

The following example shows how to convert Markdown to PDF using Java. Markdown is located in cloud storage, converted to PDF and saved 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.pdf");
 9
10OperationResult result = api.convert(builder);

C++

The following example demonstrates how to convert Markdown to PDF using C++. The Markdown file is stored in cloud storage, then converted to PDF format, and finally saved back to the same cloud storage location.

 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.pdf";
18
19// Conversion
20auto result = api->convertStorageToStorage(src, dst);

Python

The following example shows how to convert Markdown to PDF Python language applying. The Markdown file is stored in cloud storage, then converted to PDF format, and finally saved back to the same cloud storage location. 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.pdf",
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 PDF using PHP. Markdown is located in cloud storage, converted to PDF and saved to the cloud. 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.pdf';
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 PDF Ruby language applying. The Markdown file is stored in cloud storage, then converted to PDF format, and finally saved back to the same cloud storage location. 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.pdf" # 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 PDF Node.js language applying. The Markdown file is stored in cloud storage, then converted to PDF format, and finally saved back to the same cloud storage location.

 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.pdf"; // {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 PDF Swift language applying. Markdown is located in cloud storage, converted to PDF and saved to the 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.pdf"
16
17let expectation = self.expectation(description: "testConvert to pdf")
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 pdf. 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 Markdown to PDF using Java/Android. The Markdown file is stored in cloud storage, then converted to PDF format, and finally saved back to the same cloud storage location. 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.md")
 8                .saveToStorage("output.pdf");
 9
10OperationResult result = api.convert(builder);

CURL

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

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

Convert Markdown to PDF – Cloud SDKs and REST API

Markdown to PDF

Examples of Markdown to PDF Conversion

Example 1. Convert Markdown to PDF with default save options

Example 2. Convert Markdown to PDF with explicitly specified options

Example 3. Convert Markdown to PDF inside cloud storage

See Also