ReadMeWorkFlow.md

ReadMe Cheat sheet

Important

Check out the official documentation on GitHub to learn more.

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is intended to be easy to read in its source code form. This cheat sheet is here to provide you with a comprehensive understanding of the main commands in Markdown, it's aimed at enhancing your GitHub README.

• Headings
• Text styles
• Syntax Highlighting
  • Inline code
  • Code block
  • Diff Code block
• Alignments
• Tables
• Links
  • Inline
  • Reference
  • Footnote
  • Relative
  • Auto
  • Section
• Images
• Badges
• Lists
  • Ordered
  • Unordered
  • Task
• Buttons
• Collapsible items (2023)
• Horizontal Rule
• Diagrams (2022)
• Mathematical expressions (2022)
• Alerts
• Mention people and teams
• Reference issues and pull requests
• Color models
• Miscellaneous
  • Comments
  • Escaping Markdown Characters
• Hash symbol
  • Emojis
  • Line break
  • Back to top
• Tools

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 1

Heading 2

Text styles

Bold
**Lorem ipsum dolor sit amet**
__Lorem ipsum dolor sit amet__
<strong>Lorem ipsum dolor sit amet</strong>

Italic
*Lorem ipsum dolor sit amet*
_Lorem ipsum dolor sit amet _
<em>Lorem ipsum dolor sit amet</em>

Bold and Italic
**_Lorem ipsum dolor sit amet_**
<strong><em>Lorem ipsum dolor sit amet</em></strong>

Lorem ipsum dolor sit amet

Bold

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Italic

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Bold and Italic

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Blockquotes

> Lorem ipsum dolor sit amet
> Lorem ipsum dolor sit amet
>
> Lorem ipsum dolor sit amet
>
> Lorem ipsum dolor sit amet
> Lorem ipsum dolor sit amet
>> Lorem ipsum dolor sit amet
>>> Lorem ipsum dolor sit amet
> **Lorem ipsum** *dolor sit amet*

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Monospaced
<samp>Lorem ipsum dolor sit amet</samp>

Underlined
<ins>Lorem ipsum dolor sit amet</ins>

Strike-through
~~Lorem ipsum dolor sit amet~~

Monospaced

Lorem ipsum dolor sit amet

Underlined

Lorem ipsum dolor sit amet

Strike-through

Lorem ipsum dolor sit amet

Boxed
<table><tr><td>Lorem ipsum dolor sit amet</td></tr></table>

Boxed

Lorem ipsum dolor sit amet

2 <sup>53-1</sup> and -2 <sup>53-1</sup>

2 ^53-1 and -2 ^53-1

Subscript <sub>Lorem ipsum dolor sit amet</sub>
Superscript <sup>Lorem ipsum dolor sit amet</sup>

Subscript _{Lorem ipsum dolor sit amet}

Superscript ^{Lorem ipsum dolor sit amet}

Syntax Highlighting

Inline code

A class method is an instance method of the class object. When a new class is created, an object of type Class is initialized and assigned to a global constant (Mobile in this case).

Code block

public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};

public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};

Refer to this and this GitHub document to find all the valid keywords.

Diff Code block

- this code or text is the old version
+ this is what it was changed to

```diff
- this code or text is the old version
+ this is what it was changed to
```

Alignments

<p align="left">
<img src="https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg">
</p>

<p align="center">
<img src="https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg">
</p>

<p align="right">
<img src="https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg">
</p>

<h3 align="center"> My latest mistake </h3>

My latest mistake

Tables

<table>
<tr>
<td width="33%"">
Lorem ipsum dolor sit amet
</td>
<td width="33%">
Lorem ipsum dolor sit amet
</td>
<td width="33%">
Lorem ipsum dolor sit amet
</td>
</tr>
</table>

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

| Default | Left align | Center align | Right align |
| - | :- | :-: | -: |
| 9999999999 | 9999999999 | 9999999999 | 9999999999 |
| 999999999 | 999999999 | 999999999 | 999999999 |
| 99999999 | 99999999 | 99999999 | 99999999 |
| 9999999 | 9999999 | 9999999 | 9999999 |

| Default    | Left align | Center align | Right align |
| ---------- | :--------- | :----------: | ----------: |
| 9999999999 | 9999999999 | 9999999999   | 9999999999  |
| 999999999  | 999999999  | 999999999    | 999999999   |
| 99999999   | 99999999   | 99999999     | 99999999    |
| 9999999    | 9999999    | 9999999      | 9999999     |

Default    | Left align | Center align | Right align
---------- | :--------- | :----------: | ----------:
9999999999 | 9999999999 | 9999999999   | 9999999999
999999999  | 999999999  | 999999999    | 999999999
99999999   | 99999999   | 99999999     | 99999999
9999999    | 9999999    | 9999999      | 9999999

Default	Left align	Center align	Right align
9999999999	9999999999	9999999999	9999999999
999999999	999999999	999999999	999999999
99999999	99999999	99999999	99999999
9999999	9999999	9999999	9999999

Default	Left align	Center align	Right align
9999999999	9999999999	9999999999	9999999999
999999999	999999999	999999999	999999999
99999999	99999999	99999999	99999999
9999999	9999999	9999999	9999999

Default	Left align	Center align	Right align
9999999999	9999999999	9999999999	9999999999
999999999	999999999	999999999	999999999
99999999	99999999	99999999	99999999
9999999	9999999	9999999	9999999

<table>
<tr>
<th>Heading 1</th>
<th>Heading 2</th>
</tr>
<tr>

<td>

| A | B | C |
|--|--|--|
| 1 | 2 | 3 |

</td><td>

| A | B | C |
|--|--|--|
| 1 | 2 | 3 |

</td></tr> </table>

Heading 1	Heading 2
A B C 1 2 3	A B C 1 2 3

| A | B | C |
|---|---|---|
| 1 | 2 | 3 <br/> 4 <br/> 5 |

A	B	C
1	2	3 4 5

<table>
<tr>
<th>Before Hoisting</th>
<th>After Hoisting</th>
</tr>
<tr>
<td>
<pre lang="js">
console.log(fullName); // undefined
fullName = "John Doe";
console.log(fullName); // John Doe
var fullName;
</pre>
</td>
<td>
<pre lang="js">
var fullName;
console.log(fullName); // undefined
fullName = "John Doe";
console.log(fullName); // John Doe
</pre>
</td>
</tr>
</table>

Before Hoisting	After Hoisting
console.log(fullName); // undefined fullName = "John Doe"; console.log(fullName); // John Doe var fullName;	var fullName; console.log(fullName); // undefined fullName = "John Doe"; console.log(fullName); // John Doe

Links

Inline

[GitHub Readme Cheat Sheet](https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md)

GitHub README Cheat Sheet

Reference

[GitHub README Cheat Sheet][reference text]

[GitHub README Cheat Sheet][1]

[Markdown-Cheat-Sheet]

[reference text]: https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md
[1]: https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md
[Markdown-Cheat-Sheet]: https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md

GitHub README Cheat Sheet

GitHub README Cheat Sheet

Markdown-Cheat-Sheet

Footnote

Footnote.¹

Some other footnote.²

Footnote.[^1]

Some other footnote.[^2]

[^1]: This is footnote number one.
[^2]: Here is the second footnote.

Relative

[Example of a relative link](ReadMeWorkFlow.md)

Example of a relative link

Auto

Visit https://github.com/

Visit https://github.com/

Section

Images

![alt text](https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg)

![alt text][image]

[image]: https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg

<img src="https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/Images/Fox.jpg">

Badges

![GitHub forks](https://img.shields.io/github/forks/Loris-Moreau/Git-Workflow?style=for-the-badge)

Lists

Ordered

1. One
2. Two
3. Three

1. One
2. Two
3. Three

1. First level
    1. Second level
        - Third level
            - Fourth level
2. First level
    1. Second level
3. First level
    1. Second level

1. First level
2. Second level - Third level
   • Fourth level
3. First level
4. Second level
5. First level
6. Second level

Unordered

* 1
* 2
* 3

+ 1
+ 2
+ 3


- 1
- 2
- 3

• 1
• 2
• 3

• 1
• 2
• 3

• 1
• 2
• 3

- First level
    - Second level
        - Third level
            - Fourth level
- First level
    - Second level
- First level
    - Second level

• First level
  • Second level
    • Third level
      • Fourth level
• First level
  • Second level
• First level
  • Second level

<ul>
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
<li>Fourth item</li>
</ul>

• First item
• Second item
• Third item
• Fourth item

Task

- [x] Fix Bug 223
- [ ] Add Feature 33
- [ ] Add unit tests

• Fix Bug 223
• Add Feature 33
• Add unit tests

Buttons

<kbd>cmd + shift + p</kbd>

cmd + shift + p

<kbd> <br> cmd + shift + p <br> </kbd>

 
 cmd + shift + p 
 

<kbd>[Markdown-Cheatsheet](https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md)</kbd>

Markdown-Cheatsheet

[<kbd>Markdown-Cheatsheet</kbd>](https://github.com/Loris-Moreau/Git-Workflow/blob/main/Workflows/ReadMeWorkFlow.md)

Markdown-Cheatsheet

Collapsible items (2023)

<details>
  <summary>Markdown</summary>

-  <kbd>[Markdown Editor](https://binarytree.dev/me)</kbd>
-  <kbd>[Table Of Content](https://binarytree.dev/toc)</kbd>
-  <kbd>[Markdown Table Generator](https://binarytree.dev/md_table_generator)</kbd>

</details>

Markdown

• Markdown-Cheatsheet
• Hello
• My GitHub

Horizontal Rule

---
***
___

---

---

---

Diagrams (2022)

pie
"Dogs" : 80
"Cats" : 20

pie
"Dogs" : 80
"Cats" : 20

Loading

Mathematical expressions (2022)

This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$

This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$

x = {-b \pm \sqrt{b^2-4ac} \over 2a}

$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$

Alerts

> [!NOTE]
> Essential details that users should not overlook, even when browsing quickly.

> [!TIP]
> Additional advice to aid users in achieving better outcomes.

> [!IMPORTANT]
> Vital information required for users to attain success.

> [!WARNING]
> Urgent content that requires immediate user focus due to possible risks.

> [!CAUTION]
> Possible negative outcomes resulting from an action.

Note

Essential details that users should not overlook, even when browsing quickly.

Tip

Additional advice to aid users in achieving better outcomes.

Important

Vital information required for users to attain success.

Warning

Urgent content that requires immediate user focus due to possible risks.

Caution

Possible negative outcomes resulting from an action.

Mention people and teams

@Loris-Moreau

@Loris-Moreau

Reference issues and pull requests

#

#

Color models

`#ffffff`
`#000000`

Miscellaneous

Comments

<!--
Lorem ipsum dolor sit amet
-->

Escaping Markdown Characters

Before escaping

*   Asterisk
\   Backslash
`   Backtick
{}  Curly braces
.   Dot
!   Exclamation mark
#   Hash symbol
-   Hyphen symbol
()  Parentheses
+   Plus symbol
[]  Square brackets
_   Underscore`

• Asterisk \ Backslash ` Backtick {} Curly braces . Dot ! Exclamation mark

Hash symbol

• Hyphen symbol () Parentheses

• Plus symbol [] Square brackets _ Underscore

After escaping

\*   Asterisk
\\   Backslash
\`   Backtick
\{}  Curly braces
\.   Dot
\!   Exclamation mark
\#   Hash symbol
\-   Hyphen symbol
\()  Parentheses
\+   Plus symbol
\[]  Square brackets
\_   Underscore

* Asterisk \ Backslash ` Backtick {} Curly braces . Dot ! Exclamation mark # Hash symbol - Hyphen symbol () Parentheses + Plus symbol [] Square brackets _ Underscore

Emojis

:octocat:

Complete list of github markdown emoji markup

Line break

You can use <br> to insert a single line break. Make sure to use an em space  . For example:

<table><tr><td> <br> Lorem ipsum dolor sit amet <br> </td></tr></table>

Lorem ipsum dolor sit amet

Or

<table><tr><td> <br><br><br> Lorem ipsum dolor sit amet <br><br><br> </td></tr></table>

Lorem ipsum dolor sit amet

Back to top

First place the following code at start of your markdown file

<a name="top"></a>

Then use one of the following code at the place you want to return to top.

Back to top

⬆️

[Back to top](#top)

[:arrow_up:](#top)

Tools

1. Create a Markdown table of content - binarytree, github-markdown-toc
2. Create an empty Markdown table - Tablesgenerator
3. Convert Excel to Markdown table - Tableconvert
4. Markdown preview for Sublime Text 3 - Packagecontrol
5. Markdown preview Visual Studio Code - Markdown Preview Enhanced
6. A collection of awesome markdown goodies - Awesome Markdown

Footnotes

1. This is footnote number one. ↩

2. Here is the second footnote. ↩