Ariadocs

Markdown

Edit on GitHub

Render the Markdown in API descriptions.

Preview

Returns every email you have sent. Use limit to set the page size.

This link is shown as text, because it isn't safe.

Descriptions in an OpenAPI spec are Markdown, written by whoever wrote the spec. Markdown renders paragraphs, headings, lists, code, bold, italics and links.

It never renders raw HTML. Links are checked first, so a javascript: link becomes plain text. Links to other sites open in a new tab.

import { Markdown } from "@ariadocs/components";

<Markdown>{operation.description}</Markdown>;