Skip to content

Latest commit

 

History

History
361 lines (245 loc) · 7.18 KB

markdown-cheat-sheet.md

File metadata and controls

361 lines (245 loc) · 7.18 KB

Markdown cheat sheet


Heading

# Heading 1
## Heading 2
### Heading 3

Paragraph

Paragraph

Emphasized text

_Emphasized text_ or *Emphasized text*

Example: Emphasized text

Underlining Text

<u> My Underlined Text</u>

Example: My Underlined Text

Strike through text

~~Strikethrough text~~

Example: Strikethrough text

Superscript

This is a <sup>superscript</sup> text

Example: This is a superscript text

Strong text

__Strong text__ or **Strong text**

Example: Strong text

Strong emphasized text

___Strong emphasized text___ or ***Strong emphasized text***

Example: Strong emphasized text

Text colors and fonts

In his beard lived three <span style="color:red">cardinals</span>.
I am in <span style="font-family:Papyrus; font-size:4em;">LOVE!</span>

Example:

  • In his beard lived three cardinals.
  • I am in LOVE!

Links

[Sample Link](http://www.example.com/) and <http://example.com/>

Example: Sample Link and http://example.com/

Goto Any heading

[heading-1](#heading-1 "Goto heading-1")

Example: Goto Heading

Table

| First Header | Second Header |
| ------------ | ------------- |
| Content Cell | Content Cell  |
| Content Cell | Content Cell  |

Example:

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Adding a pipe | in a cell

| First Header | Second Header |
| ------------ | ------------- |
| Content Cell | Content Cell  |
| Content Cell | \             |

Example:

First Header Second Header
Content Cell Content Cell
Content Cell \

Left, right and center aligned table

| Left aligned Header | Right aligned Header | Center aligned Header |
| :------------------ | -------------------: | :-------------------: |
| Content Cell        |         Content Cell |     Content Cell      |
| Content Cell        |         Content Cell |     Content Cell      |

Example:

Left aligned Header Right aligned Header Center aligned Header
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell

Quoting code

Use `git status` to list all new or modified files that haven't yet been committed.

Example: Use git status to list all new or modified files that haven't yet been committed.

code Block

```ruby
```

Example

def sum(a,b)
  a + b
end

Bullet list

* Bullet list
  * Nested bullet
    * Sub-nested bullet etc
* Bullet list item 2

-OR-

- Bullet list
  - Nested bullet
    - Sub-nested bullet etc
- Bullet list item 2

Example:

  • Bullet list
    • Nested bullet
      • Sub-nested bullet etc
  • Bullet list item 2

Ordered List

1. A numbered list
  1. A nested numbered list
  2. Which is numbered
2. Which is numbered

Example:

  1. A numbered list
    1. A nested numbered list
    2. Which is numbered
  2. Which is numbered

Task List

- [ ] An uncompleted task
- [x] A completed task

Example:

  • An uncompleted task
  • A completed task

Subtask

- [ ] Project 1
  - [ ] Subtask 1

Example:

  • Project 1
    • Subtask 1

Blockquote

> Blockquote
>> Nested Blockquote

Example:

Blockquote

Nested blockquote

Horizontal line

- - - -

Example:


Image with alt

![picture alt](http://example.com/200x150)

Example: picture alt

Foldable text

<details>
  <summary>Title 1</summary>
  <p>Title 1 Title 1 Title 1</p>
</details>

Example:

Title 1

Title 1 Title 1 Title 1

Title 2

Title 2 Title 2 Title 2

Link to a specific part of the page

[text goes here](#section_name)

Example: Go To TOP

Hotkey

<kbd>⌘F</kbd>

Example:

⌘F ⇧⌘F

Hotkey list

Key Symbol
Option
Control
Command
Shift
Caps Lock
Tab
Esc
Power
Return
Delete
Up
Down
Left
Right

Emoji

❗ Use emoji icons to enhance text. 👍 Look up emoji codes at emoji-cheat-sheet.com

Code appears between colons :EMOJICODE:

Footnotes

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces.
  This is a second line.

Example:

Here is a simple footnote1.

A footnote can also have multiple lines2.

Alerts

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

Example:

Note

Highlights information that users should take into account, even when skimming.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Hiding content with comments

<!-- This content will not appear in the rendered Markdown -->

Footnotes

  1. My reference.

  2. To add line breaks within a footnote, prefix new lines with 2 spaces. This is a second line.