GitHub Markdown is a lightweight and easy-to-use syntax for styling your writing on GitHub. This guide will introduce you to the basics of Markdown so you can start documenting your projects like a pro!
Create headings by starting a line with #
. Add more #
for subheadings:
# This is an H1
## This is an H2
### This is an H3
Add bold or italic text:
**This text is bold**
*This text is italic*
- Unordered lists: Use
-
,+
, or*
:
- Item 1
- Item 2
- Subitem 1
- Subitem 2
- Ordered lists: Use numbers:
1. Item 1
2. Item 2
1. Subitem 1
2. Subitem 2
Create links by wrapping the link text in [ ]
and the URL in ( )
:
[GitHub](https://github.com)
Add images similarly to links, but start with !
:

Create blockquotes using >
:
> This is a blockquote
Inline code uses backticks:
`inline code`
Code blocks use triple backticks:
code block
Create tables using |
to separate columns and -
to separate the header row from the data rows:
| Header 1 | Header 2 |
| -------- | -------- |
| Row 1 | Data 1 |
| Row 2 | Data 2 |
Create task lists using - [ ]
for unchecked items and - [x]
for checked items:
- [x] Task 1
- [ ] Task 2
- [ ] Task 3
Strikethrough text using ~~
:
~~This was a mistake~~
Add emojis using :emoji_name:
:
:smile: :rocket: :tada:
With this guide, you should have a solid foundation in GitHub Markdown. Happy documenting! π₯³