Render a Markdown document | Sample

3 body fields

textstringrequired

The Markdown text to render in HTML.

modestringoptional

The rendering mode.

Allowed:markdowngfmDefault:markdown

contextstringoptional

The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.

2 status codes

200Response

304Not modified

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.markdown.create({
  text: "Lorem ipsum",
  mode: "example",
  context: "Lorem ipsum",
});

"<p>Hello <strong>world</strong></p>"