/Markdown-CheatSheet

A short reference for documenting markdown files :page_facing_up:.

MIT LicenseMIT

Markdown CheatSheet

Markdown

Table of contents

Text styling

# This is heading 1

## This is heading 2

### This is heading 3

#### This is heading 4

This is normal text.

This is normal text.

This is **bold** from wrapping the text with double asterisks.

This is bold from wrapping the text with double asterisks.

This is _italic_ from wrapping the text with an underscore.

This is italic from wrapping the text with an underscore.

Wrapping the text with double tildes makes a strikethrough.

~~This is my first idea.~~

This is my first idea.

This is my new idea.

Adding Links

This is a [website](google.com) link

This is a website link.

Link to page section

Link to the page section can be added by referring to the heading. It it same as normal link but a minor change. The link in the same page section referred with the #heading-separeted-by-dash and in different page section referred as url#heading-separeted-by-dash all in lower case.

Go to [Text Styling](#text-styling)

Go to Text Styling

Adding Image

It's similar to adding links, but the only difference is that it starts with an exclamation mark (!). Additionally, the text enclosed in square brackets ([ ]) is the alt text that is shown in place of the image when it can't be displayed. It should describe what is seen in the photo.

![The GitHub Logo](/Images/GitHub_Logo_White.png)

The GitHub Logo

Lists

To create an unordered list, use the - or * symbol.

- List 1

* List 2

  • List 1
  • List 2

To create an ordered list, just add the list in numbered format.

  1. List 1
  2. List 2
  3. List 3

Nested List

- item 1 
  - item 1a
  - item 1b

- item 2
- item 3

  • item 1

    • item 1a
    • item 1b

  • item 2

  • item 3

Check List

- [ ] item 1
- [x] item 2
- [ ] item 3
  • item 1
  • item 2
  • item 3

Table

| heading1       |    heading2    |       heading3 |
| :------------- | :------------: | -------------: |
| row 1 column 1 | row 1 column 2 | row 1 column 3 |
heading1 heading2 heading3
row 1 column 1 row 1 column 2 row 1 column 3

Note:

  • The colon below heading 1 is on the left to ensure the column text is left aligned.
  • The two colons below haeding 2 are on both sides to ensure the column text is centered.
  • The colon below heading 3 is on the right to ensure the column text is right aligned.
  • You can't have a list inside a table (but you can use some HTML to figure it out).

Code

Inline Code

This is inline code: `const name = 'Shubham';`. We use bacticks.

This is inline code: const name = 'Shubham';. We use backticks.

Block of code

We make use of three bacticks to wrap a block of code. For syntax highlighting, add the name of programming language you are using right after the first three bacticks, followed by a new line. The name of the language can be abbreviated in some occasions (for example, both js and javascript can be used to describe JavaScript code).

```js
function sayHello(name){
      console.log("Hello", ${name});
}
const name= 'Shubham';
sayHello(name);
```

function sayHello(name){
      console.log("Hello", ${name});
}
const name= 'Shubham';
sayHello(name);

Before and After in Code

Let's say you change a line in the block of code and you want to display it accordingly. To do that you can simply use the 'diff' after the first three backticks.

Add '-' before the line of code that you want to change or delete.

Add '+' before the new line of code you want to add.

```diff
- const firstName = 'Shubham';
+ const firstName = 'Divyanshi';
const lastName = 'Kadam';
```

- const firstName = 'Shubham';
+ const firstName = 'Divyanshi';
const lastName = 'Kadam';

Quotes

Use '>' to create a quote. The quote is more like a question and the answer and can be in a simple text as shown below.

> I think we should go with option 1 of create a website

I think we should go with option 1 of create a website

Great Idea, this discussion was really useful. I will go ahead and do it.

Comments

Comments span multiple lines and are invisible in the viewer, but can be seen in the editor. They are the same as HTML comments.

<!-- This is a comment -->

<!--
    This is a
    multi-line comment
-->

Collapsible content

<details>
      <summary>Click for more information</summary>
      This is more description...
</details>
Click for more information This is more description...