Markdown CheatSheet @ Coding:¶

Building a Docs Website that requires .md files? Well here is a cheat sheet:

Bold:¶

To make your text BOLD simply add 2 asterisks before and after.

1

**BOLD TEXT**

Italic:¶

To make your text italic simply add 1 asterisk before and after.

1

*Italic Text*

Bullet Points:¶

To do bullet points in .md files. Simply do - at the start of the line.

1

- My Bullet Point....

Blockquote:¶

To do blockquote in .md files. Simply do > at the start of the line.

1

> My blockquote

Link:¶

To link something in .md files do: [Text](link with https://)

Code:¶

To code in .md files. Do ` before and after.

1

`print("hi")`

Headings:¶

To add a heading simply add a hashtag before the heading.

1

# Heading

You can do sub-titles by adding an extra hashtag.

1
2
3

# Heading
## Heading 2
### Heading 3

Horizontal Line:¶

To add a break line oor etc in .md files. Do ---.

1
2
3
4
5

Text

---

More Text

Images:¶

To add a image to your .md files. Simply do:

1

![Inset Alt Text Here](Insert Image File Name Here)

Tables:¶

To add a image to your .md files. Simply do:

1
2
3
4

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Footnotes:¶

To add footnotes to your .md files. Simply do:

1
2
3

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

Subscript & Superscript:¶

To add Subscript to your .md files. Simply do:

1

H~2~O

To add superscript to your .md files. Simply do:

1

X^2^

Highlight:¶

To highlight text in your .md files. Simply add two equal sings before and after.

1

==Highlighted text==

Admonitions:¶

In addition to the basic Markdown syntax. You can have a special admonitions syntax by wrapping text with a set of 3 colons, followed by a label denoting its type.

1
2
3
4
5

:::note

This feature is AMAZING!

:::