How to write markdown in GitHub README?

 

Step 1: Create a new GitHub repository

 

• Sign in to your GitHub account.
• Click the “+” icon in the top right corner and select “New repository.”
• Enter a repository name (for example, my-first-repo).
• Optionally add a description and choose Public or Private.
• Click “Create repository.”

 

Step 2: Clone the repository to your local machine

 

git clone https://github.com/username/my-first-repo.git
cd my-first-repo

 

Step 3: Create a README.md file

 

touch README.md

 

Step 4: Add a main heading in Markdown

 

• Open README.md in your code editor.
• Use a single hash (#) to create the main title.

# My First Repository

 

Step 5: Write descriptive text and paragraphs

 

• Simply type your content below the heading as plain text.

This repository contains my first GitHub project. Here I will experiment with Markdown syntax to format text, lists, code snippets, images, and more.

 

Step 6: Create bullet and numbered lists

 

• Use hyphens or asterisks for unordered lists.
• Use numbers followed by periods for ordered lists.

- First bullet item
- Second bullet item

1. First numbered item
2. Second numbered item

 

Step 7: Add code blocks

 

• Wrap code with triple backticks (\`\`\`).
• Specify a language for syntax highlighting (e.g., `bash or `javascript).

```
npm install
npm start
```

 

Step 8: Insert inline code

 

• Wrap code snippets inside single backticks (\`).

To run the script, type `node index.js` in your terminal.

 

Step 9: Embed images

 

• Upload an image to your repo or use an external URL.
• Use the syntax ![alt text](image-url).

![Logo](https://example.com/logo.png)

 

Step 10: Add hyperlinks

 

• Use the syntax [link text](https://example.com).

[Visit GitHub](https://github.com)

 

Step 11: Create tables

 

• Use pipes (|) and dashes (-).

| Feature       | Description               |
| ------------- | ------------------------- |
| Headings      | #, ##, ###                |
| Lists         | -, \*, 1.                  |
| Code blocks   | \`\`\`                       |

 

Step 12: Preview your README

 

• Commit and push your changes.
• Visit your repository on GitHub to see the rendered README.

git add README.md
git commit -m "Add README with Markdown examples"
git push origin main

 

Step 13: Iterate and improve

 

• Edit README.md to refine formatting or add sections (Usage, Contributing, License).
• Repeat the preview steps until you’re satisfied.

 

That's it! You now know how to write and format Markdown in a GitHub README.