https://github.com/kerolloz/markdown
GitHub's Markdown syntax guide
https://github.com/kerolloz/markdown
guide learn learning markdown markdown-guide readme
Last synced: 3 months ago
JSON representation
GitHub's Markdown syntax guide
- Host: GitHub
- URL: https://github.com/kerolloz/markdown
- Owner: kerolloz
- Created: 2019-05-23T15:44:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T15:49:31.000Z (over 1 year ago)
- Last Synced: 2024-03-10T16:52:06.133Z (over 1 year ago)
- Topics: guide, learn, learning, markdown, markdown-guide, readme
- Homepage: https://kerolloz.github.io/markdown
- Size: 21.5 KB
- Stars: 64
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Markdown Reference
## Headers
```markdown
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
```
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
## Lists
Unordered list
```markdown
- item
- item
- item
```
- item
- item
- item
---
Ordered list
```markdown
1. item
1. item
1. item
```
1. item
1. item
1. item
---
Nested lists
```markdown
- item
- sub-item
- sub-sub-item
```
- item
- sub-item
- sub-sub-item
## TODOs
```markdown
- [x] Learn Python
- [ ] Learn Java
```
- [x] Learn Python
- [ ] Learn Java
## Text Format
```markdown
*italic*
**bold**
~~strikethrough~~
```
*italic*
**bold**
~~strikethrough~~
## Images
```markdown
```
## Links
```markdown
checkout my [website](https://kerolloz.github.io/)
```
checkout my [website](https://kerolloz.github.io/)
## Image With link
```markdown
[](https://imgur.com/gallery/sw215)
```
[](https://imgur.com/gallery/sw215)
## Code
```markdown
this is a small `code` block
```
this is a small `code` block
----
This is a block of code with syntax highlighting:
~~~~markdown
```python
print("Hello World")
```
~~~~
```python
print("Hello World")
```
## Block quote
```markdown
>look how this renders
```
>look how this renders
---
```markdown
>block one
>>nested block
```
>block one
>>nested block
## Table
Notice the colon `:` place
```markdown
left aligned | centered | right aligned
-------------|:--------:|--------------:
data | data | data
```
left aligned | centered | right aligned
-------------|:--------:|--------------:
data | data | data
## Horizontal Line
```markdown
up
---
down
```
up
---
down
## New line
You can make a new line by ending a line with *two spaces*, you don't have to use `
`.
## Note, Warning, and Tip
```
> [!NOTE]
> This is a note
> [!WARNING]
> This is a warning
> [!TIP]
> This is a tip
> [!IMPORTANT]
> This is important
> [!CAUTION]
> This is a caution
```
Becomes:
> [!NOTE]
> This is a note
> [!WARNING]
> This is a warning
> [!TIP]
> This is a tip
> [!IMPORTANT]
> This is important
> [!CAUTION]
> This is a caution
---
## NOTE
In order to be able to see the effects of the tricks used in the following sections
please view it from the [website](//kerolloz.github.io/markdown#definitions).
**Viewing it from GitHub's README won't show the effect!**
---
## Definitions
```markdown
Markdown
: Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.
```
Markdown
: Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.
## Abbreviations
```markdown
HTML is easy.
*[HTML]: Hyper Text Markup Language
```
HTML is easy.
*[HTML]: Hyper Text Markup Language
**
## Footnote
```markdown
the book [^1] has good exercises
[^1]: you can find the book on Google.
```
the book [^1] has good exercises
[^1]: you can find the book on Google.