Markdown to HTML parses markdown syntax and converts it to clean, semantic HTML suitable for web rendering and content management.
npm install @apiverve/markdowntohtmlshell
npm install @apiverve/markdowntohtml
`
Using yarn:
`shell
yarn add @apiverve/markdowntohtml
`
---
Configuration
Before using the Markdown to HTML API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com
---
Quick Start
Get started with the Quick Start Guide
The Markdown to HTML API documentation is found here: https://docs.apiverve.com/ref/markdowntohtml.
You can find parameters, example responses, and status codes documented here.
$3
`javascript
const markdowntohtmlAPI = require('@apiverve/markdowntohtml');
const api = new markdowntohtmlAPI({
api_key: '[YOUR_API_KEY]'
});
`
---
Usage
---
$3
Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
`javascript
var query = {
"markdown": "# Hello World\n\nThis is a bold statement and this is italic.\n\n## Features\n\n- Easy to use\n- Fast conversion\n- Supports common markdown syntax\n\nLink to example"
};
api.execute(query, function (error, data) {
if (error) {
return console.error(error);
} else {
console.log(data);
}
});
`
---
$3
You can also use promises to make requests. The API returns a promise that you can use to handle the response.
`javascript
var query = {
"markdown": "# Hello World\n\nThis is a bold statement and this is italic.\n\n## Features\n\n- Easy to use\n- Fast conversion\n- Supports common markdown syntax\n\nLink to example"
};
api.execute(query)
.then(data => {
console.log(data);
})
.catch(error => {
console.error(error);
});
`
---
$3
You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
`javascript
async function makeRequest() {
var query = {
"markdown": "# Hello World\n\nThis is a bold statement and this is italic.\n\n## Features\n\n- Easy to use\n- Fast conversion\n- Supports common markdown syntax\n\nLink to example"
};
try {
const data = await api.execute(query);
console.log(data);
} catch (error) {
console.error(error);
}
}
`
---
Example Response
`json
{
"status": "ok",
"error": null,
"data": {
"html": "Hello World
\nThis is a bold statement and this is italic.
\nFeatures
\n\n- Easy to use
\n- Fast conversion
\n- Supports common markdown syntax
\n
\n\n",
"markdownLength": 185,
"htmlLength": 272
}
}
``