An open API service indexing awesome lists of open source software.

https://github.com/yashksaini-coder/github-markdown-beginner-guide

GitHub Markdown Beginner Guide 📘
https://github.com/yashksaini-coder/github-markdown-beginner-guide

Last synced: 4 months ago
JSON representation

GitHub Markdown Beginner Guide 📘

Awesome Lists containing this project

README

          

# GitHub Markdown Beginner Guide 📘

## Introduction 🚀
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!

## Basic Syntax 📝

### Headings 🏷️
Create headings by starting a line with `#`. Add more `#` for subheadings:

```markdown
# This is an H1
## This is an H2
### This is an H3
```

### Emphasis ✨
Add **bold** or *italic* text:

```markdown
**This text is bold**
*This text is italic*
```

### Lists 📋
- **Unordered lists:** Use `-`, `+`, or `*`:

```markdown
- Item 1
- Item 2
- Subitem 1
- Subitem 2
```

- **Ordered lists:** Use numbers:

```markdown
1. Item 1
2. Item 2
1. Subitem 1
2. Subitem 2
```

### Links 🔗
Create links by wrapping the link text in `[ ]` and the URL in `( )`:

```markdown
[GitHub](https://github.com)
```

### Images 🖼️
Add images similarly to links, but start with `!`:

```markdown
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
```

### Blockquotes 💬
Create blockquotes using `>`:

```markdown
> This is a blockquote
```

### Code ⌨️
Inline code uses backticks:

```markdown
`inline code`
```

Code blocks use triple backticks:

```
code block
```

## Advanced Syntax 🚀✨

### Tables 📊
Create tables using `|` to separate columns and `-` to separate the header row from the data rows:

```markdown
| Header 1 | Header 2 |
| -------- | -------- |
| Row 1 | Data 1 |
| Row 2 | Data 2 |
```

### Task Lists ✅
Create task lists using `- [ ]` for unchecked items and `- [x]` for checked items:

```markdown
- [x] Task 1
- [ ] Task 2
- [ ] Task 3
```

### Strikethrough ❌
Strikethrough text using `~~`:

```markdown
~~This was a mistake~~
```

### Emojis 😄
Add emojis using `:emoji_name:`:

```markdown
:smile: :rocket: :tada:
```

## Conclusion 🎉
With this guide, you should have a solid foundation in GitHub Markdown. Happy documenting! 🥳