markdown

The tagged template literal function which wraps the text in an object that is displayed as Markdown-formatter string.

The Markdown syntax is based on GitHub Flavored Markdown, and supports math formatting with KaTeX (wrap inline math expressions in $ and block math expressions in $$, escape \ as \\).

Syntax

markdown(string)

Parameters

• string

  A string.

Return value

An instance of Markdown object that will be displayed as Markdown-formatted text.

Examples

markdown`See **Calcish** [website](https://calcish.com).`

markdown`
# Hello, world!

~~~js
Math.sin(2)
~~~

This *is* a **test**.
`