Markdown Examples

Base Syntax

Example text with nothing specific

Bold

bold text

Italic

italicized text

Blockquote

blockquote

Ordered List

1. First item
2. Second item
3. Third item

Unordered List

• First item
• Second item
• Third item

Code

code

Horizontal Rule

---

Link

absolute URL

relative URL

Extended Syntax

Table

Syntax	Description
Header	Title
Paragraph	Text

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote

Here's a sentence with a footnote. ¹

Heading ID

My Great Heading

Definition List

term : definition

Strikethrough

The world is flat.

Task List

• Write the press release
• Update the website
• Contact the media

Tabs

First

Example text with an emoji 🟢 Good info 🔴 Bad info

Second

console.log("Hello, world!");

Third

{
  "status": {
    "key0": 0,
    "key1": 1,
    "key2": 123,
    "key3": 1234,
    "key4": 123456
  }
}

Info Admonitions

Available cases: caution, note, important, tip, warning

caution

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed in turpis dignissim sapien sodales dignissim. Phasellus malesuada viverra consectetur. Aliquam et diam quis lectus luctus molestie. Pellentesque a dictum orci.

Custom Title

The content and title can include markdown. For example:

console.log("Hello, world!");

important

example/endpoint text about it

tip

Lorem ipsum dolor sit amet !

caution

Oh, no ! Lorem ipsum dolor sit amet

---

GET API Call

GET API Call

POST API Call

Custom Title

The content and title can include markdown. For example:

First

Path Parameters

https://example.com/*param*

Param	Required	Type	Description
bech32Address	REQUIRED	string	The Address to query.
gasPrice	OPTIONAL	number	The desired Gas Price (per Gas Unit).
storageKey	REQUIRED	string	The storage entry to fetch.
bech32Address	REQUIRED	string	The Address to query.

Second

console.log("Hello, world!");

Third

🟢 200 OK

Value (hex-encoded) successfully retrieved.

{
  "status": {
    "key0": 0,
    "key1": 1,
    "key2": 123,
    "key3": 1234,
    "key4": 123456
  }
}

LaTeX

LaTeX Example

Inline

Text that contains a function $f(a,b,c) = (a^2+b^2+c^2)^3$ and continues after that function.

Text that contains an integral $\int_{a}^{b} x^2 \,dx$ and continues after that $\binom{n}{k}$

Block

$$f(a,b,c) = (a^2+b^2+c^2)^3$$

Example text

$$\binom{n}{k} = \frac{n!}{k!(n-k)!}$$ $$\relax{y} = \int_{-\infty}^\infty \hat\xi\,e^{2 \pi i \xi x} \,d\xi$$ $$|x| = \begin{Bmatrix} x & {if } x \geq 0 \\ -x & {if } x < 0 \end{Bmatrix}$$

YouTube Embed

First Version

Second version

Mermaid diagrams

Footnotes

1. This is the footnote. ↩