An Informative Guide To Markdown Of GitHub

An Informative Guide To Markdown Of GitHub

Write an awesome README

what is Markdown?

Markdown is a way of writing rich-text (formatted text) content using plain text formatting syntax. From this post, you’ll learn all the Markdown’s major commands that will help you create an awesome GitHub README.

Text

Paragraph

Paragraphs are separated by a blank line.

This is another paragraph.

output:

Paragraphs are separated by a blank line.

This is another paragraph

Font style

It's very easy to make some words italic and other words bold. Any word wrapped with two tildes (like~~Scrached this~~) will appear crossed out.

Emphasis, aka italics, with *asterisks* or _underscores_.

Strong emphasis, aka bold, with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~

output:

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

You can even link to [google](https://google.com).

output:

You can even link to google.

Structure

Headers

You can structure your texts in the following way:

# Title
## Subtitle
### Another deeper title

You can use one `#` all the way up to `######` six for different title sizes

output:

Title

Subtitle

Another deeper title

Lists

Bullet list:
* Start a line with an asterisk
* Food
  * Fruits
    * Oranges


Numbered list:
1. One
2. Two
3. Three

output:

Bullet list:

  • Start a line with an asterisk
  • Food
    • Fruits
      • Oranges

Numbered list:

  1. One
  2. Two
  3. Three

Quote

If you'd like to quote someone, use the > character before the line:

> This is a blockquote.
>
> This is the second paragraph.

output:

This is a blockquote.

This is the second paragraph.

Images

If you want to insert images, this is how you do it:

![LCO](https://learncodeonline.in/mascot.png "Title is optional')

output:

Text

Code

To write a code you have to use ```code```

Inline `code` has `back-ticks around` it.

Tables

A table in markdown consists of two parts.

  • The header
  • The rows of data in the table You can create tables with pipes|and hyphens-. Hyphens are used to create each column's header, while pipes separate each column.
Rows in the table are separated by line breaks
| Column 1 Header | Column 2 Header | Column 3 Header |
| --------------- | --------------- | --------------- |
| Row 1 Column 1 | Row 1 Column 2 | Row 1 Column 3 |
| Row 2 Column 1 | Row 2 Column 2 | Row 2 Column 3 |
| Row 3 Column 1 | Row 3 Column 2 | Row 3 Column 3 |

output:

Column 1 HeaderColumn 2 HeaderColumn 3 Header
Row 1 Column 1Row 1 Column 2Row 1 Column 3
Row 2 Column 1Row 2 Column 2Row 2 Column 3
Row 3 Column 1Row 3 Column 2Row 3 Column 3

Did you find this article valuable?

Support Chhakuli Zingare by becoming a sponsor. Any amount is appreciated!