On this page

Markdown Styling

Heading example

Here is an example of headings. You can use this heading by the following markdown rules. For example: use # for heading 1 and use ###### for heading 6.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Emphasis

The emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

The combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. ~~Scratch this.~~

Links

There are many different ways to create links in Markdown:

# Basic Links
[Basic link](https://example.com)
[Link with title](https://example.com "Hover over me!")
[Link with emphasis *italics*](https://example.com)
[Link with **bold**](https://example.com)

# Reference Links
[Reference link][1]
[Reference link with name][website]
[Bare reference link][]

[1]: https://example.com
[website]: https://example.com "Optional title"
[Bare reference link]: https://example.com

# URL and Email
https://example.com
contact@example.com

Here’s how they look when rendered:

Basic link

Link with title

Link with emphasis italics

Link with bold

Reference link

Reference link with name

Bare reference link

https://example.com

contact@example.com

Paragraph

Lorem ipsum dolor sit amet consectetur adipisicing elit. Quam nihil enim maxime corporis cumque totam aliquid nam sint inventore optio modi neque laborum officiis necessitatibus, facilis placeat pariatur! Voluptatem, sed harum pariatur adipisci voluptates voluptatum cumque, porro sint minima similique magni perferendis fuga! Optio vel ipsum excepturi tempore reiciendis id quidem? Vel in, doloribus debitis nesciunt fugit sequi magnam accusantium modi neque quis, vitae velit, pariatur harum autem a! Velit impedit atque maiores animi possimus asperiores natus repellendus excepturi sint architecto eligendi non, omnis nihil. Facilis, doloremque illum. Fugit optio laborum minus debitis natus illo perspiciatis corporis voluptatum rerum laboriosam.

Ordered List

List item
List item
List item
List item
List item

Unordered List

List item
List item
List item
List item
List item

Code and Syntax Highlighting

This is an Inline code sample.

var s = "JavaScript syntax highlighting";
alert(s);

s = "Python syntax highlighting"
print s

Blockquote

This is a blockquote example.

Tables

Markdown	Less	Pretty
Still	`renders`	nicely
1	2	3

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don’t need to make the raw Markdown line up prettily. You can also use inline Markdown.

Details and Summary

Details elements are great for creating expandable sections:

Basic example

This is a simple details element with plain text content.

With Markdown inside summary

You can use Markdown inside the details:

List item 1
List item 2

// Even code blocks work
const x = "Hello World";

🔍 Common use case: API Response

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Example"
  }
}

💡 Implementation Notes

Important: Remember to add a blank line after the summary tag when using Markdown inside details.

This ensures proper Markdown parsing.