Home - yasinnaal/github-markdown-cheatsheet GitHub Wiki

Welcome to the Github Markdown Cheatsheet (syntax) wiki

For any suggestions or feedback click here

Table of Contents

Headers
Emphasis (Style Text Bold, Italic, strikethrough)
Blockquotes
Lists
Ordered List
List CheckBox - Task Lists
Email
Code - Programing languages
Links
Line Breaks
Horizontal Line
Tables
Images
Emoji
Shields Badges

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1

H2

H3

H4

H5
H6

Emphasis

*Text will be italic*

_Text will be italic_

**Text will be bold**

__Text  will be bold__

*You **can** combine them*

~~strikethrough text (deleted text)~~ or <del>strikethrough text (deleted text)</del>

Text will be italic

Text will be italic

Text will be bold

Text will be bold

You can combine them

strikethrough text (deleted text) or strikethrough text (deleted text)

Blockquotes

As Grace Hopper said:
> I’ve always been more interested
> in the future than in the past.

As Grace Hopper said:

I’ve always been more interested in the future than in the past.

Lists

* Item 1
* Item 2
  * Item 2a (add tow spaces manually)
  * Item 2b (add tow spaces manually)
* Item 3
  • Item 1
  • Item 2
    • Sub Item (add tow spaces manually)
    • Sub Item (add tow spaces manually)
  • Item 3

Ordered

1. Item 1
2. Item 2
  * Item 2a (add tow spaces manually)
  * Item 2b (add tow spaces manually)
3. Item 3
  1. Item 1
  2. Item 2
  • Item 2a (add space manually)
  • Item 2b (add space manually)
  1. Item 3

List CheckBox or Tasks Lists

- [ ] Item A
- [x] Item B
- [x] Item C
  • Item A
  • Item B
  • Item C

Email

<[email protected]>

[email protected]

Code

You can add language identifier after ``` to enable syntax highlighting in code block.

ABAP

```ABAP
REPORT Z_HELLO_WORLD.

* ABAP Hello World!
" we use * or " to write comments, both are supported.

write 'Hello World'.
```

REPORT Z_HELLO_WORLD.

* ABAP Hello World!
" we use * or " to write comments, both are supported.

write 'Hello World'.

rubby

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

java

```java
// Your First java Program
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!"); 
    }
}
```

// Your First java Program
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!"); 
    }
}

You can find out which programing language keywords are valid in the languages YAML file.

Links

[click here to go to Google](wwww.google.com)

click here to go to Google

Line Breaks

line 1<br>
line 2<br>
line 3<br>

line 1
line 2
line 3

Horizontal Line

Hyphens (Dash)
---

Asterisks
***

Underscores
___

Hyphens (Dash)

Asterisks

Underscores

Tables

|Column 1|Column 2|Column 3|
|---|:---|---:|
|Row 1 Column 1| Row 1 Column 2| Row 1 Column 3|
|Row 2 Column 1| Row 2 Column 2| Row 2 Column 3|

Note: Colons : are used to align columns lef, right, center.
Column 1 Column 2 Column 3
Row 1 Column 1 Row 1 Column 2 Row 1 Column 3
Row 2 Column 1 Row 2 Column 2 Row 2 Column 3

Images

![anytext](https://github.com/yasinnaal/images/blob/main/github_logo.png)

or

<img src="https://github.com/yasinnaal/images/blob/main/github_logo.png?raw=true">

or

to add tip text on mouse hover

![alt text](https://github.com/yasinnaal/images/blob/main/github_logo.png "Github Logo")

alt text

Emoji

Emoji
People - (😊 , 😯 , ❤️)
Nature - (☀️ , ⛄ , 🐶)
Objects - (📁 , 💻 , 🔔)
Places - (:house: , ⚠️ , 🗽)
Symbols - (:parking: , ❌ , :wheelchair:)
Kaomoji

Special-Symbols

Shields Badges

See more:
https://shields.io/
https://github.com/badges/shields

ddd

GitHub Repo forks

GitHub Repo stars

You can search on https://shields.io/ to see all github badges and create your own.

You can show information about your repository like forks total...etc.

References: markdown cheatsheet online pdf

⚠️ **GitHub.com Fallback** ⚠️