Convert Markdown to Image – Cloud SDKs and REST API Markdown to Image Converting Markdown (MD) to image formats can be useful for embedding Markdown content in environments or platforms where Markdown rendering is not directly supported. It makes it easy to share Markdown content on social media, embed it in presentations, or include it in websites without Markdown rendering capabilities.
Aspose.HTML Cloud v4.0 provides the simplest API to convert MD documents to Image file formats with high quality, easy and fast.
The article explains in a set of code examples how to convert an Markdown document to Image file formats such as JPEG , PNG , GIF , TIFF or BMP using Aspose.HTML Cloud SDKs and REST API calls. SDKs are available in PHP, C++, Python, C#, Ruby, Java, Android, Swift, and Node.js. We will consider various scenarios of Markdown to Image conversion: from storage to storage, from a local file system to the local file system, etc.
SDK Examples of Markdown to Image Conversion A widespread use case for Aspose.HTML Cloud SDK functions is file processing and converting. Cloud SDK allows you to fetch an Markdown document from a storage location by its name or from a local file on your drive, convert it to a specified format, and save it to storage or your local drive. The following code examples demonstrate how to convert Markdown to Image for different cases using available SDKs.
Example 1. Convert Markdown to JPG JPG is one of the most commonly used image formats. Its uniqueness is the controlled loss of quality during compression. Therefore, it is widely used to store and send graphic content (photos, scanned copies, digitized images) over the Internet. Let’s look at an example of converting a local Markdown file to JPG format and saving the result to a local file system. The conversion occurs with default conversion options.
C# The following example demonstrates the simplest way to convert Markdown to JPG using C#. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the C# SDK from the
GitHub repository .
Copy 1 // Initialize SDK API
2 = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" ). ConvertApi ;
3
4 // Convert Markdown to JPG
5 = await api. ConvertAsync ( "test.md" , "test.jpg" ); Java The following example demonstrates how to convert Markdown to JPG using Java. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the java SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 JobBuilder builder = new ConverterBuilder()
7 . fromLocalFile ( "input.md" )
8 . saveToLocal ( "output.jpeg" );
9
10 OperationResult result = api. convert ( builder); C++ The following example demonstrates how to convert Markdown to JPG C++ language applying. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system.
Copy 1 // Get current directory
2 std: : string cur_dir ( argv[ 0 ]);
3 int pos = cur_dir. find_last_of ( "/\\" );
4 cur_dir = cur_dir. substr ( 0 , pos + 1 ); // Include the last slash
5 std: : wstring w_cur_dir ( cur_dir. begin (), cur_dir. end ());
6
7 const utility:: string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ;
8 const utility:: string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" ;
9 const utility:: string_t basePath = L"https://api.aspose.cloud/v4.0" ;
10 const utility:: string_t authPath = L"https://api.aspose.cloud/connect/token" ;
11
12 // Create configuration for authorization
13 std: : shared_ptr< ApiConfiguration> apiConfig ( new ApiConfiguration( clientId, clientSecret, basePath, authPath));
14
15 // Create client from configuration
16 std: : shared_ptr< ApiClient> apiClient ( new ApiClient( apiConfig));
17
18 // Create ConversionApi
19 std: : shared_ptr< ConversionApi> api = std:: make_shared< ConversionApi>( apiClient);
20
21 // File name for conversion
22 utility: : string_t src = w_cur_dir + L"test.md" ;
23 utility: : string_t dst = w_cur_dir + L"result.jpeg" ;
24
25 // Conversion
26 = api-> convertLocalToLocal( src, dst);
27
28 // Check the result file
29 = result-> getFile();
30 std: : ifstream f ( re. c_str ());
31 if (! f. good ())
32 {
33 throw std:: runtime_error( "Conversion failed" );
34 } Python The following example demonstrates how to convert Markdown to JPG Python language applying. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the Python SDK from the
GitHub repository .
Copy 1 from asposehtmlcloud. configuration import Configuration
2 from asposehtmlcloud. api . html_api import HtmlApi
3 from asposehtmlcloud. api_client import ApiClient as Client
4 from asposehtmlcloud. rest import ApiException
5
6 configuration = 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)
11 client = Client( configuration)
12 html_api = HtmlApi( client)
13
14 try:
15 res = html_api. convertApi . convert_local_to_local ( input_file= "test.md" , output_file= "test.jpeg" )
16 except ApiException as ex:
17 print( "Exception" )
18 print( "Info: " + str( ex))
19 raise ex PHP The following example demonstrates how to convert Markdown to JPG using PHP. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the PHP SDK from the
GitHub repository
Copy 1 <? php
2 require_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. jpeg ' ;
16
17 try {
18 // Request to server Api
19 = $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 JPG Ruby language applying. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the Ruby SDK from the
GitHub repository .
Copy 1 # load the gem
2 require ' 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 CONFIG = {
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
16 api_instance = AsposeHtml:: HtmlApi. new CONFIG
17
18 src = "test.md" # String | Full path to the input file.
19 dst = "test.jpeg" # String | Full path to the result.
20
21 begin
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
25 rescue AsposeHtml:: ApiError => e
26 puts "Exception when calling api_instance.convert_local_to_local: #{e}"
27 end Node.js The following example demonstrates how to convert Markdown to JPG Node.js language applying. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system.
Copy 1 // Get keys from aspose site.
2 // There is free quota available.
3 // For more details, see https://purchase.aspose.cloud/pricing
4 5 var 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
13 var api = require( ' @asposecloud / aspose- html- cloud' );
14
15 // Create Conversion Api object
16 = new api. ConversionApi ( conf);
17
18 var src = "/path/to/src/test.md" ; // {String} Source document.
19 = "/path/to/dst/test.jpeg" ; // {String} Result document.
20 = null ;
21
22 var callback = function( error, data, response) {
23 if ( error) {
24 console. error ( error);
25 } else {
26 console. log ( data);
27 }
28 };
29
30 conversionApi. convertLocalToLocal ( src, dst, opts, callback); Swift The following example demonstrates how to convert Markdown to JPG Swift language applying. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the Swift SDK from the
GitHub repository .
Copy 1 import Alamofire
2 import Foundation
3 import XCTest
4 import AsposeHtmlCloud
5
6 static let fm = FileManager. default
7 let resourceDir = fm. homeDirectoryForCurrentUser . appendingPathComponent ( "Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources" )
8 let resultDir = fm. homeDirectoryForCurrentUser . appendingPathComponent ( "Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/TestResult" )
9
10 func url ( forResource fileName: String) -> URL {
11 return resourceDir. appendingPathComponent ( fileName)
12 }
13
14 func fileExist ( name: String) -> Bool {
15 return FileManager. default . fileExists ( atPath: name)
16 }
17
18 ClientAPI. 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
26 let fileName = "test.md"
27 let format = "jpeg"
28 let src = url( forResource: fileName). absoluteString
29
30 let expectation = self. expectation ( description: "testConvert to \(format)" )
31 let dst = resultDir. appendingPathComponent ( "Output.\(format)" ). absoluteString
32 HtmlAPI. 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 }
42 self. waitForExpectations ( timeout: 100.0 , handler: nil) Java/Android The following example demonstrates how to convert Markdown to JPG using Java/Android. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. You can download the Java/Android SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 JobBuilder builder = new ConverterBuilder()
7 . fromLocalFile ( "input.md" )
8 . saveToLocal ( "output.jpeg" );
9
10 OperationResult result = api. convert ( builder); CURL The following example demonstrates how to convert Markdown to JPG using REST API. A Markdown file located locally is converted to JPG image and subsequently saved to the local file system. Take 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 . Copy 1 curl - X POST - v \
2 "https://api.aspose.cloud/v4.0/html/conversion/md-jpg" \
3 - d "{'InputPath': '/testpage.md', 'OutputFile': 'test.jpg'}" \
4 - H "Content-Type: application/json" \
5 - H "Authorization:Bearer <JWT_token>" Markdown to JPG conversion occurs with the default conversion options : the resulting JPG document’s width and height correspond to A4, and all margins have zero value.
Example 2. Convert Markdown to PNG with explicitly specified options PNG image format widely takes to transmit pictures over the network, display photos and graphics on web-pages and reserve in cloud storages. Markdown to PNG conversion may be required, for example, if you want to add a web page in a PowerPoint presentation, insert it on a blog for your readers, or send it by e-mail. The example below shows how to convert Markdown to PNG with explicitly specified options and save the result back to the local file system.
C# The following SDK example demonstrates how to convert Markdown to PNG using C#. Markdown is taken from the local file system, converted to PNG and saved to the local drive. You can download the C# SDK from the
GitHub repository .
Copy 1 // Initialize SDK API
2 = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" ). ConvertApi ;
3
4 // Create an options instance and specify options for Markdown to PNG conversion
5 = new ImageConversionOptions()
6 . SetHeight ( 800 )
7 . SetWidth ( 1000 )
8 . SetLeftMargin ( 10 )
9 . SetRightMargin ( 10 )
10 . SetBottomMargin ( 10 )
11 . SetTopMargin ( 10 );
12
13 // Convert Markdown to PNG
14 = await api. ConvertAsync ( "test.md" , "test.png" , options); Java The following example demonstrates how to convert Markdown to PNG using Java. Markdown is taken from the local file system, converted to PNG and saved to the local path. You can download the java SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 ImageConversionOptions opt = new ImageConversionOptions()
7 . setWidth ( 600 )
8 . setHeight ( 900 )
9 . setTopMargin ( 20 )
10 . setBottomMargin ( 20 )
11 . setLeftMargin ( 20 )
12 . setRightMargin ( 20 );
13
14 JobBuilder builder = new ConverterBuilder()
15 . fromLocalFile ( "input.md" )
16 . useOptions ( opt)
17 . saveToLocal ( "output.png" );
18
19 OperationResult result = api. convert ( builder); C++ The following example demonstrates how to convert Markdown to PNG using C++. Markdown is taken from the local file system, converted to PNG and saved to the local file system.
Copy 1 // Get current directory
2 std: : string cur_dir ( argv[ 0 ]);
3 int pos = cur_dir. find_last_of ( "/\\" );
4 cur_dir = cur_dir. substr ( 0 , pos + 1 ); // Include the last slash
5 std: : wstring w_cur_dir ( cur_dir. begin (), cur_dir. end ());
6
7 const utility:: string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ;
8 const utility:: string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" ;
9 const utility:: string_t basePath = L"https://api.aspose.cloud/v4.0" ;
10 const utility:: string_t authPath = L"https://api.aspose.cloud/connect/token" ;
11
12 // Create configuration for authorization
13 std: : shared_ptr< ApiConfiguration> apiConfig ( new ApiConfiguration( clientId, clientSecret, basePath, authPath));
14
15 // Create client from configuration
16 std: : shared_ptr< ApiClient> apiClient ( new ApiClient( apiConfig));
17
18 // Create ConversionApi
19 std: : shared_ptr< ConversionApi> api = std:: make_shared< ConversionApi>( apiClient);
20
21 // File name for conversion
22 utility: : string_t src = w_cur_dir + L"test.md" ;
23 utility: : string_t dst = w_cur_dir + L"result.png" ;
24
25 std: : shared_ptr< ConversionOptions> opts = std:: make_shared< ConversionOptions>();
26 opts-> setWidth( 800 )
27 -> setHeight( 600 )
28 -> setLeftMargin( 10 )
29 -> setRightMargin( 10 )
30 -> setTopMargin( 10 )
31 -> setBottomMargin( 10 );
32
33 // Conversion
34 = api-> convertLocalToLocal( src, dst, opts);
35
36 // Check the result file
37 = result-> getFile();
38 std: : ifstream f ( re. c_str ());
39 if (! f. good ())
40 {
41 throw std:: runtime_error( "Conversion failed" );
42 } Python The following example demonstrates how to convert Markdown to PNG Python language applying. Markdown is taken from the local file system, converted to PNG and saved to the local drive. You can download the Python SDK from the
GitHub repository .
Copy 1 from asposehtmlcloud. configuration import Configuration
2 from asposehtmlcloud. api . html_api import HtmlApi
3 from asposehtmlcloud. api_client import ApiClient as Client
4 from asposehtmlcloud. rest import ApiException
5
6 configuration = 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)
11 client = Client( configuration)
12 html_api = HtmlApi( client)
13
14 options = {
15 ' width' : 600 ,
16 ' height' : 900 ,
17 ' topmargin' : 20 ,
18 ' bottommargin' : 20 ,
19 ' leftmargin' : 20 ,
20 ' rightmargin' : 20
21 }
22
23 try:
24 res = html_api. convertApi . convert_local_to_local ( input_file= "test.md" , output_file= "test.png" , options= options)
25 except ApiException as ex:
26 print( "Exception" )
27 print( "Info: " + str( ex))
28 raise ex PHP The following example demonstrates how to convert Markdown to PNG using PHP. Markdown is taken from the local file system, converted to PNG and saved to the local file. You can download the PHP SDK from the
GitHub repository
Copy 1 <? php
2 require_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. png ' ;
16
17 $options = [
18 ' width' => 800 ,
19 ' height' => 600 ,
20 ' left_margin' => 20 ,
21 ' right_margin' => 20 ,
22 ' top_margin' => 20 ,
23 ' bottom_margin' => 20
24 ];
25
26
27 try {
28 // Request to server Api
29 = $api_html-> convertLocalToLocal( $src, $dst, $options);
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 PNG Ruby language applying. Markdown is taken from the local file system, converted to PNG and saved to the local drive. You can download the Ruby SDK from the
GitHub repository .
Copy 1 # load the gem
2 require ' 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
9 CONFIG = {
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
17 api_instance = AsposeHtml:: HtmlApi. new CONFIG
18
19 src = "test.md" # String | Source file.
20 dst = "test.png" # String | Result file.
21
22 opts = {
23 width: 700 , # Float | Resulting image width in pixels.
24 height: 1000 , # Float | Resulting image height in pixels.
25 left_margin: 40 , # Float | Left resulting image margin in pixels.
26 right_margin: 40 , # Float | Right resulting image margin in pixels.
27 top_margin: 50 , # Float | Top resulting image margin in pixels.
28 bottom_margin: 50 # Float | Bottom resulting image margin in pixels.
29 }
30
31 begin
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
35 rescue AsposeHtml:: ApiError => e
36 puts "Exception when calling api_instance.convert_local_to_local: #{e}"
37 end Node.js The following example demonstrates how to convert Markdown to PNG Node.js language applying. Markdown is taken from the local file system, converted to PNG and saved to the local file.
Copy 1 // Get keys from aspose site.
2 // There is free quota available.
3 // For more details, see https://purchase.aspose.cloud/pricing
4 5 var 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
13 var api = require( ' @asposecloud / aspose- html- cloud' );
14
15 // Create Conversion Api object
16 = new api. ConversionApi ( conf);
17
18 var src = "/path/to/src/test.md" ; // {String} Source document.
19 = "/path/to/dst/test.png" ; // {String} Result document.
20 = {
21 ' width' : 600 ,
22 ' height' : 800 ,
23 ' leftMargin' : 10 ,
24 ' rightMargin' : 20 ,
25 ' topMargin' : 30 ,
26 ' bottomMargin' : 40
27 };
28
29 var callback = function( error, data, response) {
30 if ( error) {
31 console. error ( error);
32 } else {
33 console. log ( data);
34 }
35 };
36
37 conversionApi. convertLocalToLocal ( src, dst, opts, callback); Swift The following example demonstrates how to convert Markdown to PNG Swift language applying. Markdown is taken from the local file system, converted to PNG and saved to the local drive. You can download the Swift SDK from the
GitHub repository .
Copy 1 import Alamofire
2 import Foundation
3 import XCTest
4 import AsposeHtmlCloud
5
6 static let fm = FileManager. default
7 let resourceDir = fm. homeDirectoryForCurrentUser . appendingPathComponent ( "Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/Resources" )
8 let resultDir = fm. homeDirectoryForCurrentUser . appendingPathComponent ( "Documents/Aspose.HTML.Cloud.SDK.Swift/Tests/AsposeHtmlCloudTests/TestResult" )
9
10 func url ( forResource fileName: String) -> URL {
11 return resourceDir. appendingPathComponent ( fileName)
12 }
13
14 func fileExist ( name: String) -> Bool {
15 return FileManager. default . fileExists ( atPath: name)
16 }
17
18 ClientAPI. 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
26 let fileName = "test.md"
27 let format = "png"
28 let src = url( forResource: fileName). absoluteString
29 let options = Options( width: 800 , height: 600 , leftMargin: 10 ,
30 rightMargin: 10 , topMargin: 10 , bottomMargin: 10 )
31
32
33 let expectation = self. expectation ( description: "testConvert to \(format)" )
34 let dst = resultDir. appendingPathComponent ( "Output.\(format)" ). absoluteString
35 HtmlAPI. 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 }
45 self. waitForExpectations ( timeout: 100.0 , handler: nil) Java/Android The following example demonstrates how to convert Markdown to PNG using Java/Android. Markdown is taken from the local file system, converted to PNG and saved to the local path. You can download the Java/Android SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 ImageConversionOptions opt = new ImageConversionOptions()
7 . setWidth ( 600 )
8 . setHeight ( 900 )
9 . setTopMargin ( 20 )
10 . setBottomMargin ( 20 )
11 . setLeftMargin ( 20 )
12 . setRightMargin ( 20 );
13
14 JobBuilder builder = new ConverterBuilder()
15 . fromLocalFile ( "input.md" )
16 . useOptions ( opt)
17 . saveToLocal ( "output.png" );
18
19 OperationResult result = api. convert ( builder); CURL The following example demonstrates how to convert Markdown to PNG using REST API. Local Markdown converted to PNG and saved to the local file system.
Please take a few 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 . Copy 1 curl - X POST - v \
2 "https://api.aspose.cloud/v4.0/html/conversion/md-png" \
3 - d "{'InputPath': '/testpage.md', 'OutputFile': 'test.png', '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 GIF 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.
C# The following example shows how to convert Markdown to GIF using C#. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the C# SDK from the
GitHub repository .
Copy 1 // Initialize SDK API
2 = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" ). ConvertApi ;
3
4 // Convert Markdown to GIF
5 = new ConverterBuilder()
6 . FromStorageFile ( "/test.md" )
7 . ToStorageFile ( "/test.gif" );
8
9 var result = await api. ConvertAsync ( builder); Java The following example shows how to convert Markdown to GIF using Java. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the java SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 JobBuilder builder = new ConverterBuilder()
7 . fromStorageFile ( "input.md" )
8 . saveToStorage ( "output.gif" );
9
10 OperationResult result = api. convert ( builder); C++ The following example demonstrates how to convert Markdown to GIF using C++. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage.
Copy 1 const utility:: string_t clientId = L"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ;
2 const utility:: string_t clientSecret = L"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" ;
3 const utility:: string_t basePath = L"https://api.aspose.cloud/v4.0" ;
4 const utility:: string_t authPath = L"https://api.aspose.cloud/connect/token" ;
5
6 // Create configuration for authorization
7 std: : shared_ptr< ApiConfiguration> apiConfig ( new ApiConfiguration( clientId, clientSecret, basePath, authPath));
8
9 // Create client from configuration
10 std: : shared_ptr< ApiClient> apiClient ( new ApiClient( apiConfig));
11
12 // Create ConversionApi
13 std: : shared_ptr< ConversionApi> api = std:: make_shared< ConversionApi>( apiClient);
14
15 // File name for conversion
16 utility: : string_t src = L"file/in/storage/index.md" ;
17 utility: : string_t dst = L"result/in/storage/result.gif" ;
18
19 // Conversion
20 = api-> convertStorageToStorage( src, dst); Python The following example shows how to convert Markdown to GIF Python language applying. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the Python SDK from the
GitHub repository .
Copy 1 from asposehtmlcloud. configuration import Configuration
2 from asposehtmlcloud. api . html_api import HtmlApi
3 from asposehtmlcloud. api_client import ApiClient as Client
4 from asposehtmlcloud. rest import ApiException
5
6 configuration = 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)
11 client = Client( configuration)
12 html_api = HtmlApi( client)
13
14 try:
15 res = html_api. convertApi . convert_storage_to_storage ( input_file= "test.md" , output_file= "test.gif" ,
16 storage_name= None)
17 except ApiException as ex:
18 print( "Exception" )
19 print( "Info: " + str( ex))
20 raise ex PHP The following example demonstrates how to convert Markdown to GIF using PHP. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the PHP SDK from the
GitHub repository .
Copy 1 <? php
2 require_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. gif ' ;
16 $options = null ;
17
18 try {
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 GIF Ruby language applying. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the Ruby SDK from the
GitHub repository .
Copy 1 # load the gem
2 require ' 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
9 CONFIG = {
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
17 api_instance = AsposeHtml:: HtmlApi. new CONFIG
18
19 src = "FolderInStorage/test.md" # String | Source file.
20 dst = "FolderInStorage/test.gif" # String | Result file.
21 storage = nil
22
23 begin
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
27 rescue AsposeHtml:: ApiError => e
28 puts "Exception when calling api_instance.convert_storage_to_storage: #{e}"
29 end Node.js The following example shows how to convert Markdown to GIF Node.js language applying. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage.
Copy 1 // Get keys from aspose site.
2 // There is free quota available.
3 // For more details, see https://purchase.aspose.cloud/pricing
4 5 var 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
13 var api = require( ' @asposecloud / aspose- html- cloud' );
14
15 // Create Conversion Api object
16 = new api. ConversionApi ( conf);
17
18 var src = "FolderInStorage/test.md" ; // {String} Source document.
19 = "FolderInStorage/test.gif" ; // {String} Result document.
20 = null ;
21 var storage = null ;
22
23 var callback = function( error, data, response) {
24 if ( error) {
25 console. error ( error);
26 } else {
27 console. log ( data);
28 }
29 };
30
31 conversionApi. convertStorageToStorage ( src, dst, storage, opts, callback); Swift The following example shows how to convert Markdown to GIF Swift language applying. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the Swift SDK from the
GitHub repository .
Copy 1 import Alamofire
2 import Foundation
3 import XCTest
4 import AsposeHtmlCloud
5
6 ClientAPI. 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
14 let src = "FolderInStorage/test.md"
15 let dst = "FolderInStorage/test.gif"
16
17 let expectation = self. expectation ( description: "testConvert to gif" )
18
19 HtmlAPI. convertStorageToStorage ( src: src, dst: dst, storage: nil, options: nil) { ( data, error) in
20
21 guard error == nil else {
22 XCTFail( "Error convert Markdown to gif. 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 }
39 self. waitForExpectations ( timeout: 100.0 , handler: nil) Java/Android The following example shows how to convert Markdown to GIF using Java/Android. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage. You can download the Java/Android SDK from the
GitHub repository .
Copy 1 Configuration. setBasePath ( "https://api.aspose.cloud" );
2 Configuration. setAuthPath ( "https://api.aspose.cloud/connect/token" );
3
4 HtmlApi api = new HtmlApi( "CLIENT_ID" , "CLIENT_SECRET" );
5
6 JobBuilder builder = new ConverterBuilder()
7 . fromStorageFile ( "input.md" )
8 . saveToStorage ( "output.gif" );
9
10 OperationResult result = api. convert ( builder); CURL The following example demonstrates how to convert Markdown to GIF using REST API. Markdown file is located in cloud storage, converted to GIF and saved back to cloud storage.
Copy 1 curl - X POST - v \
2 "https://api.aspose.cloud/v4.0/html/conversion/md-gif" \
3 - d "{'InputPath': '/test.md', 'OutputFile': '/test.gif'}" \
4 - H "Content-Type: application/json" \
5 - H "Authorization:Bearer <JWT_token>" See Also The
Available SDKs article introduces you to Aspose.HTML Cloud’s ability to use SDKs in various programming languages, such as C#, Java, Python, Ruby, PHP, Node.js, Swift, Android, and C++. The
SDK Conversion Options article describes a set of classes that represent options for converting a source HTML-based document to PDF, XPS, and image. Aspose.HTML Cloud API you can call directly from your browser by accessing the
API Reference . Aspose.HTML offers a free online
Markdown to Image Converter that swiftly converts Markdown to Image with high quality. Just upload your files, convert them, and get the result in a few seconds! 
