Documents

Convert Markdown to HTML

Converts Markdown (CommonMark + GFM tables/strikethrough) to plain HTML. The output is not sanitized: raw HTML inside the Markdown passes through unchanged.

Costs 1 credit per call.

post/markdown-to-html

Request

  • Base URL: https://api.cofferdock.com
  • URL: https://api.cofferdock.com/markdown-to-html
  • Auth: API key in header x-api-key

Request body

markdownstring required

The Markdown text to convert (CommonMark plus GitHub-style tables and strikethrough), up to 2 MB.

output'json' | 'html'

How to return the HTML: "json" (the HTML inside the JSON response) or "html" (the HTML itself as the response body, text/html). Default: json when the request is JSON, html when the Markdown was sent as raw text.

Response

Result.

successboolean
htmlstring

Changes

No recorded changes to this operation across all 1 revision of this API.