Skip to content

Instantly share code, notes, and snippets.

@MinhasKamal
Last active May 16, 2023 00:10
Show Gist options
  • Save MinhasKamal/7fdebb7c424d23149140 to your computer and use it in GitHub Desktop.
Save MinhasKamal/7fdebb7c424d23149140 to your computer and use it in GitHub Desktop.
Markdown Syntax for GitHub.



HEADER

# Header1
## Header2
### Header3
#### Header4
##### Header5
###### Header6
H1
===
H2
---

Header1

Header2

Header3

Header4

Header5
Header6

H1

H2



EMPHASIS

*Italic1* _Italic2_
**Bold1** __Bold2__
***Bold_Italic***
~~Strikethrough~~

Italic1 Italic2
Bold1 Bold2
Bold_Italic
Strikethrough



HORIZONTAL LINE

---
***
___





LIST

unordered list:

* item-1
  * sub-item-1
  * sub-item-2
- item-2
  - sub-item-3
  - sub-item-4
+ item-3
  + sub-item-5
  + sub-item-6


ordered list:

1. item-1
 1. sub-item-1
 2. sub-item-2
2. item-2
 1. sub-item-3
 2. sub-item-4
3. item-3

unordered list:

  • item-1
    • sub-item-1
    • sub-item-2
  • item-2
    • sub-item-3
    • sub-item-4
  • item-3
    • sub-item-5
    • sub-item-6

ordered list:

  1. item-1
  2. sub-item-1
  3. sub-item-2
  4. item-2
  5. sub-item-3
  6. sub-item-4
  7. item-3


TABLE

Table Header-1 | Table Header-2 | Table Header-3
:--- | :---: | ---:
Table Data-1 | Table Data-2 | Table Data-3
TD-4 | Td-5 | TD-6
Table Data-7 | Table Data-8 | Table Data-9
Table Header-1 Table Header-2 Table Header-3
Table Data-1 Table Data-2 Table Data-3
TD-4 Td-5 TD-6
Table Data-7 Table Data-8 Table Data-9


LINK

https://github.com/MinhasKamal/github-markdown-syntax
[GitHub](https://github.com/MinhasKamal/github-markdown-syntax)
[click](https://github.com/MinhasKamal/github-markdown-syntax "GitHub Markdown Syntax")
[README](/README.md)
[Image](#image)

https://github.com/MinhasKamal/github-markdown-syntax
GitHub
click
README
Image



IMAGE

![GitHub Logo](https://cloud.githubusercontent.com/assets/5456665/13322882/e74f6626-dc00-11e5-921d-f6d024a01eaa.png "GitHub")

GitHub Logo



QUOTE

> Stay hungry; stay foolish.
>> Quality is better than quantity.
>>> Life is not fair; get used to it.

Stay hungry; stay foolish.

Quality is better than quantity.

Life is not fair; get used to it.



COMMENT

[/]:# (This is a comment, you cannot see it)


CODE

inline code- `int i=0`

block code-
``` C
for(int i=0; i<10; i++){
    printf("Hallow World! \n");
}
```

inline code- int i=0

block code-

for(int i=0; i<10; i++){
    printf("Hallow World! \n");
}


GITHUB EMOJI

:octocat: :rabbit: :alien: :+1: :bee: :bell: :ghost: :bulb: :imp:

:octocat: 🐰 👽 👍 🐝 🔔 👻 💡 👿

more...



OTHERS

Which one does @torvalds like most?
- [ ] tiger \#
- [ ] whale \*
- [X] octocat \!

Which one does @torvalds like most?

  • tiger #
  • whale *
  • octocat !


HTML TAGS

<div align="center">
    <kbd>Markdown</kbd> also supports &#9608; <b>HTML</b> &#9608; <i>syntax</i> <!--invisible--> <br/>
    <a href="http://www.youtube.com/watch?feature=player_embedded&v=vq2jYFZVMDA" target="_blank">
        <img src="http://img.youtube.com/vi/vq2jYFZVMDA/0.jpg" alt="GitHub Video"
        border="10" width="460" height="250"/>
    </a>
</div>
Markdown also supports █ HTMLsyntax
GitHub Video


TEXT ART

root                         ┌───────────────────────┐             ┌──────────────┐
 ├─branch-1                  |        Vehicle        ├── has-a ───→|    Engine    |
 │  ├─sub-branch-1           └───────────────────────┘             └──────────────┘
 │  └─sub-branch-2                 ↑              ↑                      ↑   ↑                 ------\\
 ├─branch-2                        |              |                      |   |                 ┤ ^_^ |
 │  └─sub-branch-3                 |            is-a                     |   |                 └──-──┘  
 │     ├─a                         |              |                      |   |       
 │     └─b                         |         ┌────┴─────────┐            |   |
 ├─branch-3                       is-a       |    Toyota    ├── has-a ───┘   |                 ------\\
 │  └─sub-branch-4                 |         └──────────────┘                |                 ┤ @_@ |
 └─branch-4                        |                                       is-a                └──-──┘
    ├─sub-branch-5                 |                                         |       
    ├─sub-branch-6           ┌─────┴──────────┐                     ┌────────┴────┐
    │  └─c                   │   Lamborghini  ├───────has-a ───────→│  V12 Engine │
    └─sub-branch-7           └────────────────┘                     └─────────────┘


References



@helviorubens
Copy link

Thanks for this tutorial and for sharing some great examples about it.

@Ahmed-Dghaies
Copy link

Thank you for the examples.

@ithinkandicode
Copy link

Details + Summary:

Example 1

<details>
<summary>Click me</summary>
Markdown **won't** work for this line. There needs to be an empty line first.

Markdown **will** work for this line, because there's an empty line above it.
</details>
Click me Markdown **won't** work for this line. There needs to be an empty line first.

Markdown will work for this line, because there's an empty line above it.

Example 2

The <summary> tag is optional. Omitting it will make the text default to "Details", and it won't appear to be clickable in the browser.

Details can also start as open with open="true".

<details open="true">
This is open by default.
</details>
This is open by default.

@cryptoman123
Copy link

N|Solid

what does [![]N|Solid] mean in the above? And where do I find more like these?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment