Home / Tech / Markdown

Tech

Markdown cheat sheet

Markdown cheat sheet. Explore our ultimate quick reference for Markdown.

This comprehensive Markdown cheat sheet offers a detailed overview of Markdown syntax, from basic formatting like headers, lists, and emphasis, to advanced features including tables, footnotes, and extended syntax options. It serves as a practical reference for creating well-structured, accessible, and visually appealing documents in Markdown. Whether you're a beginner or an experienced user, this cheat sheet is designed to enhance your Markdown writing skills with clear examples and explanations.

Basic Syntax

Headers (atx style)

ATX Style

# h1
## h2
### h3
#### h4
##### h5
###### h6

setext style

Header 1
========
Header 2
--------

Emphasis

*italic*
_italic_

italic

**bold**
__bold__

bold

`inline code`

inline code

~~strikethrough~~

strikethrough

Blockquotes

> This is
> a blockquote
>
> > Nested
> > Blockquote

Unordered List

* Item 1
* Item 2
    * item 3a
    * item 3b

or

- Item 1
- Item 2

or

+ Item 1
+ Item 2

Ordered List

1. Item 1
2. Item 2
    a. item 3a
    b. item 3b
[link](https://cheatsheets.one)
[link][cheatsheet]
[cheatsheet]: https://cheatsheets.one
<https://cheatsheets.one>

Horizontal rule

Hyphens

---

Asterisks

***

Underscores

___

Code

```javascript
console.log("This is a block code")
```
~~~css
.button { border: none; }
~~~
    4 space indent makes a code block

inline code

`Inline code` has back-ticks around it

Tables

Header1 | Header2 | Header3
--- | --- | ---
*Italic* | `code` | **bold**
1 | 2 | 3
Header1 Header2 Header3
Italic code bold
1 2 3

Online Markdown Table Generator

Images

![GitHub Logo](/images/logo.png)

![Alt Text](url)

Image with link

[![GitHub Logo](/images/logo.png)](https://github.com/)

[![Alt Text](image_url)](link_url)

Reference style

![alt text][logo]

[logo]: /images/logo.png "Logo Title"

Line Breaks

To create a line break, end a line with two or more spaces, then press Enter.

Escaping Characters

Use a backslash (\) to escape Markdown characters and use them as regular characters without triggering their formatting features.

Advanced Syntax

Footnote

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

[^1]: This is the footnote.

Heading ID

### My Great Heading {#custom-id}

Definition List

term
: definition

Task List

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

Emoji

This is funny! :smile:
I'm thinking! :thinking:
I'm worried! :worried:

Highlight

I need to highlight these ==very important words==.

YouTube

YouTube can only be added with to following trick.

[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Backslash escapes

Characters Escape Description
\ \\ backslash
` \backtick backtick
* \* asterisk
_ \_ underscore
{} \{} curly braces
[] \[] square brackets
() \() parentheses
# \# hash mark
+ \+ plus sign
- \- minus sign (hyphen)
. \. dot
! \! exclamation mark

Extended Syntax

Differences in Markdown Flavors

There are different flavors of Markdown, like GitHub-Flavored Markdown (GFM), CommonMark, etc. Syntax and support may vary across different platforms and editors. For example markdown does not support superscript and subscript natively.

Subscript

H~2~O or H<sub>2 </sub>O

Superscript

X^2^ or X<sup>2

Table of Contents (TOC)

Automatically generate a table of contents based on headers. Usage varies by Markdown processor, often involves inserting a specific placeholder like [TOC] at the desired location.

Syntax Highlighting in Code Blocks

Specify the programming language to enable syntax highlighting.

```python
print("Hello, world!")

### Direct HTML
You can use HTML tags for content not supported by Markdown syntax.

```html
<center>This text is centered.</center>

Mathematical Equations

Embed LaTeX for mathematical equations in some Markdown processors.

$$
E = mc^2
$$

Custom Containers

::: warning
*Here be dragons!*
:::

Note: Requires support from the Markdown processor, such as Markdown-it's container plugin.

Collapsible Sections

<details>
<summary>Click to expand!</summary>

This section is collapsible.

</details>

LISTEN