Skip to content

Commit 98645d3

Browse files
Update README.md
1 parent c0430d6 commit 98645d3

File tree

1 file changed

+48
-16
lines changed

1 file changed

+48
-16
lines changed

README.md

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,55 @@
1-
# Aspose.Html Cloud Node.js SDK
2-
[Aspose.Html Cloud](https://products.aspose.cloud/html) is a true [REST API](https://apireference.aspose.cloud/html/) that enables you to perform a wide range of html processing operations including manipulation and conversion in the cloud, with zero initial costs. Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process html pages in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights.
3-
4-
- API version: 20.8.1
5-
- Package version: 20.8.1
1+
![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm (scoped)](https://img.shields.io/npm/v/@asposecloud/aspose-html-cloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/@asposecloud/aspose-html-cloud) [![GitHub license](https://img.shields.io/github/license/aspose-html-cloud/aspose-html-cloud-nodejs)](LICENSE) ![GitHub last commit](https://img.shields.io/github/last-commit/Aspose-html-Cloud/aspose-html-cloud-nodejs)
2+
# HTML Rendering & Conversion Node.js Cloud REST API
3+
Aspose.HTML Cloud for Node.js is a programming SDK that allows software developers to manipulate and convert HTML documents from within their own applications. A Wrapper of RESTful APIs, Aspose.HTML Cloud for Node.js speeds up HTML programming and conversion.
4+
This cloud SDK assists to develop cloud-based [HTML page rendering, processing, translation & conversion](https://products.aspose.cloud/html/nodejs) apps in Node.js via REST API.
5+
6+
## HTML Processing Features
7+
- Fetch the HTML page along with its resources as a ZIP archive by providing the page URL.
8+
- Based on page URL, retrieve all images of an HTML page as a ZIP package.
9+
- Load data from a local file to populate the HTML document template.
10+
- Use the request body to populate the HTML document template.
11+
- Convert HTML page to numerous other file formats.
12+
13+
## Read & Write HTML Formats
14+
HTML, XHTML, zipped HTML, zipped XHTML, MHTML, HTML containing SVG markup, Markdown, JSON
15+
16+
## Save HTML As
17+
*Fixed Layout*: PDF, XPS
18+
*Images*: TIFF, JPEG, PNG, BMP, GIF
19+
*Other*: TXT, ZIP (images)
20+
21+
## Read HTML Formats
22+
*eBook*: EPUB
23+
*Other*: XML, SVG
24+
25+
## Enhancements Version 20.11
26+
27+
- New generation of Aspose.HTML Cloud SDK for .NET (C#) is provided.
28+
- This version of SDK has been redesigned from scratch being based on the new Aspose.HTML Cloud REST API (v3.0).
29+
- Currently, it provides only the conversion feature. Other features that are still available in the versions up to v.20.08 are planned to be implemented in this SDK later.
30+
- Conversion interface provides a more flexible conversion parameters setup.
31+
- Redesigned storage access is provided using SDK entry point HtmlApi.Storage.
32+
- Availability of synchronous and asynchronous file upload and download methods.
33+
- Asynchronous download provides the ability to get progress data for the longer downloads.
634

735
## Installation
836

937
## Aspose.HTML Cloud SDK for Node.js
10-
This repository contains Aspose.HTML Cloud SDK for Node.js source code.
38+
This repository contains Aspose.HTML Cloud SDK for Node.js source code.
1139
This SDK allows you to work with Aspose.HTML Cloud REST APIs in your Node.js applications quickly and easily.
1240

1341
See [API Reference](https://apireference.aspose.cloud/html/) for full API specification.
1442

1543
## How to use the SDK?
16-
The complete source code is available in this repository folder, you can either directly use
44+
The complete source code is available in this repository folder, you can either directly use
1745
it in your project via npm package manager.
1846

1947
### Prerequisites
2048
To use Aspose HTML for Cloud Node.js SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is a free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
2149

2250
### Installation
2351

24-
#### Install Aspose.HTML Cloud
52+
#### Install Aspose.HTML Cloud
2553
### For [Node.js](https://nodejs.org/)
2654

2755
#### npm
@@ -57,9 +85,9 @@ NOTE: Use the helper from /test/helper.js for an upload and save data.
5785
```javascript
5886

5987
// Get keys from aspose site.
60-
// There is free quota available.
88+
// There is free quota available.
6189
// For more details, see https://purchase.aspose.cloud/pricing
62-
90+
6391
var conf = {
6492
"basePath":"https://api.aspose.cloud/v3.0",
6593
"authPath":"https://api.aspose.cloud/connect/token",
@@ -130,7 +158,7 @@ conversionApi.GetConvertDocumentToImage(filename, outFormat, opts, callback);
130158

131159
##### Local development
132160

133-
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
161+
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
134162
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
135163

136164
```shell
@@ -149,14 +177,14 @@ Finally, switch to the directory you want to use your package from, and run:
149177
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
150178
```
151179

152-
You should now be able to `require('@asposecloud/aspose-html-cloud')` in javascript files from the directory you ran the last
180+
You should now be able to `require('@asposecloud/aspose-html-cloud')` in javascript files from the directory you ran the last
153181
command above from.
154182

155183

156184
### For browser
157185
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
158186
the above steps with Node.js and installing browserify with `npm install -g browserify`,
159-
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
187+
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
160188
use this library):
161189

162190
```shell
@@ -230,7 +258,7 @@ Class | Method | HTTP request | Description
230258
*Asposehtmlcloud.ImportApi* | [**PostConvertMarkdownInRequestToHtml**](docs/ImportApi.md#PostConvertMarkdownInRequestToHtml) | **POST** /html/import/md | Converts the Markdown document (in request content) to HTML and uploads resulting file to storage by specified path.
231259
*Asposehtmlcloud.ImportApi* | [**PutConvertMarkdownToHtml**](docs/ImportApi.md#PutConvertMarkdownToHtml) | **PUT** /html/{name}/import/md | Converts the Markdown document (located on storage) to HTML and uploads resulting file to storage by specified path.
232260
*Asposehtmlcloud.DocumentApi* | [**GetDocumentByUrl**](docs/DocumentApi.md#GetDocumentByUrl) | **GET** /html/download | Return all HTML page with linked resources packaged as a ZIP archive by the source page URL.
233-
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentByXPath**](docs/DocumentApi.md#GetDocumentFragmentByXPath) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query.
261+
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentByXPath**](docs/DocumentApi.md#GetDocumentFragmentByXPath) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query.
234262
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentByXPathByUrl**](docs/DocumentApi.md#GetDocumentFragmentByXPathByUrl) | **GET** /html/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query by the source page URL.
235263
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentsByCSSSelector**](docs/DocumentApi.md#GetDocumentFragmentsByCSSSelector) | **GET** /html/{name}/fragments/css/{outFormat} | Return list of HTML fragments matching the specified CSS selector.
236264
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentsByCSSSelectorByUrl**](docs/DocumentApi.md#GetDocumentFragmentsByCSSSelectorByUrl) | **GET** /html/fragments/css/{outFormat} | Return list of HTML fragments matching the specified CSS selector by the source page URL.
@@ -280,7 +308,11 @@ Class | Method | HTTP request | Description
280308
node.exe ./node_modules/mocha/bin/_mocha --ui bdd ./test
281309
```
282310

311+
## Aspose.HTML Cloud SDKs in Popular Languages
283312

284-
## Documentation for Authorization
313+
| .NET | Java | PHP | Python | Ruby | Node.js | Android | Swift|C++|Go|
314+
|---|---|---|---|---|---|---|--|--|--|
315+
| [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-dotnet) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-java) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-php) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-python) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-ruby) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-nodejs) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-android) | [GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-swift)|[GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-cpp) |[GitHub](https://github.com/aspose-html-cloud/aspose-html-cloud-go) |
316+
| [NuGet](https://www.nuget.org/packages/Aspose.html-Cloud/) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-html-cloud) | [Composer](https://packagist.org/packages/aspose/aspose-html-cloud-php) | [PIP](https://pypi.org/project/asposehtmlcloud/) | [GEM](https://rubygems.org/gems/aspose_html_cloud) | [NPM](https://www.npmjs.com/package/@asposecloud/aspose-html-cloud) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-html-cloud) | [Cocoapods](https://cocoapods.org/pods/AsposeHtmlCloud)|[NuGet](https://www.nuget.org/packages/Aspose.Html-Cloud.Cpp/) | [Go.Dev](#) |
285317

286-
Please follow the [installation](#installation) instruction for write config file:
318+
[Product Page](https://products.aspose.cloud/html/nodejs) | [Documentation](https://docs.aspose.cloud/display/htmlcloud/Home) | [API Reference](https://apireference.aspose.cloud/html/) | [Code Samples](https://github.com/aspose-html-cloud/aspose-html-cloud-nodejs) | [Blog](https://blog.aspose.cloud/category/html/) | [Free Support](https://forum.aspose.cloud/c/html) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

0 commit comments

Comments
 (0)