Markdown README Cheat Sheet

A copy-paste reference for writing GitHub Markdown README files.

---

Quick Start

• Templates → templates.md
• Use sections below as needed

---

Basics

Headings

# H1
## H2
### H3

Text

*italic*
**bold**
~~strikethrough~~

Lists

- Item 1
- Item 2

1. First
2. Second

Links & Images

[Google](https://google.com)

![Alt text](image.png)

Inline Code

`code`

---

Code Blocks

npm install

console.log("Hello world");

---

README Templates

Minimal

# Project Name

## Description
Short description.

## Installation
npm install

## Usage
Example

## License
MIT

---

Standard Project

# Project Name

## Description
What this project does.

## Features
- Fast
- Simple
- Lightweight

## Installation
git clone <repo>
cd project
npm install

## Usage
npm start

## License
MIT

---

Advanced

Collapsible Section

<details>
<summary>Click to expand</summary>

Hidden content here.

</details>

Table

| Name | Age |
|------|-----|
| John | 25  |

Badges

![License](https://img.shields.io/badge/license-MIT-blue)
![Version](https://img.shields.io/badge/version-1.0.0-green)

Task List

- [x] Done
- [ ] Not done

---

License

MIT