Skip to content

Latest commit

 

History

History
168 lines (115 loc) · 3.33 KB

README.md

File metadata and controls

168 lines (115 loc) · 3.33 KB

Markdown Basics △

Master in making a wonderful README file for your repository.

What is Markdown?

  • Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown.
  • Files with the .md or .markdown extension.

Why Markdown?

Markdown is commonly used in many discussion portals (like GH Discusions, StackOverFlow) and also used in GitHub Repository's README.md file.

It is a light-weight syntax and helps to render many things (like images, links, headers, paragraphs, etc.). README.md is a special file which tells about your respository

How to create a README.md file?

Headover to your repository.

Go to add new file tab and click create new file.

Give your file name as README.md and whoha, you have made your first README.md file under your repository.

Demos

  1. Before Creating the repository:

  1. After creating the repository:

Syntax Guide

Here’s an overview of Markdown syntax that you can use.

1. Headers

Syntax

# For h1
## For h2
## For h3
### For h4

Output

For h1

For h2

For h3

For h4


2. Images

Syntax

![Image of GitHub Logo](https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg)
    ^
--Image Name
                            ^^^
------------------------- URL of the image

Output

Image of GitHub Logo

3. Lists

Syntax

Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

* Start a line with a star
* Profit!

Alternatively,

- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
  - Like this
  - And this

Output

Sometimes you want numbered lists:

  1. One
  2. Two
  3. Three

Sometimes you want bullet points:

  • Start a line with a star
  • Profit!

Alternatively,

  • Dashes work just as well
  • And if you have sub points, put two spaces before the dash or star:
    • Like this
    • And this

4. Emphasis

Syntax

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

Output

This text will be italic This will also be italic

This text will be bold This will also be bold

You can combine them

5. Links

Syntax

http://github.com - automatic!
[GitHub](http://github.com)

Output

http://github.com - automatic!

GitHub

6. Tables

Syntax

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

Output

First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

These are the some basics of Markdown. I will be adding more tricks soon. Make sure to give a ⭐ to this repository if you like this.