Cheatsheets Markdown

25 entries

Markdown

Markdown syntax for formatting documents, README files, and documentation

25 commands

CommandDescriptionExample

# Heading 1

Top-level heading (H1) using a single hash

# My Project

## Heading 2

Second-level heading (H2)

## Installation

### Heading 3

Third-level heading (H3)

### Prerequisites

**bold text**

Bold text using double asterisks

**Important:** read this first

*italic text*

Italic text using single asterisks

Use *emphasis* sparingly

~~strikethrough~~

Strikethrough text using double tildes

~~deprecated~~ use v2 instead

> blockquote text

Blockquote using a greater-than sign prefix

> This is a famous quote.

---

Horizontal rule / thematic break using three dashes

--- (renders a horizontal line)

- item - item - nested item

Unordered list with a nested item using indentation

- Apples
- Bananas
  - Green

1. First 2. Second 3. Third

Ordered list with automatic numbering

1. Clone
2. Install
3. Run

- [x] Done - [ ] Todo

Task list (GitHub Flavored Markdown) with checkboxes

- [x] Design
- [ ] Implement

[Link text](https://example.com)

Inline hyperlink with display text and URL

[Docs](https://docs.example.com)

[Link text](https://example.com "Tooltip")

Inline link with an optional title tooltip

[API](/api "API Reference")

[ref label][1] [1]: https://example.com

Reference-style link defined separately from usage

[guide][1] ... [1]: /docs/guide

![Alt text](image.png)

Inline image with alt text and a relative path

![Logo](./logo.png)

![Alt text](image.png "Title")

Inline image with alt text and a title attribute

![Screenshot](demo.png "Demo")

`inline code`

Inline code span using backticks

Run `npm install` first

```js const x = 1; ```

Fenced code block with language syntax highlighting

```ts
const x = 1;
```

indented code block

Code block created by indenting lines with four spaces

echo 'hello'

| Col 1 | Col 2 | |-------|-------| | A | B |

Basic Markdown table with a header and one data row

| Name | Role |
|------|------|
| Jo | Dev |

| Left | Center | Right | |:-----|:------:|------:|

Table with left, center, and right-aligned columns

| Left | Center | Right |

text\

Trailing backslash creates a hard line break (renders as <br>)

Line one\
Line two

\*escaped\*

Backslash escapes a Markdown special character so it renders literally

\*not italic\*

[^1]: footnote text

Footnote definition (supported in GFM and extended Markdown)

See note[^1] ... [^1]: detail

==highlighted==

Highlight text (supported in some extended Markdown renderers)

==key point==