Skip to content

Latest commit

 

History

History
286 lines (157 loc) · 4.86 KB

Markdown.md

File metadata and controls

286 lines (157 loc) · 4.86 KB

Introduction to Markdown

Markdown is a lightweight markup language with plain text formatting syntax. What this means to you is that by using just a few extra symbols in your text, Markdown helps you create a document with an explicit structure.

Why Markdown

  • Easy The syntax is very simple.

  • Fast: It speeds up the workflows.

  • Clean: No missing closing tags, no improperly nested tags, no blocks left without containers.

  • Portable: Cross-platform by nature.

  • Flexible: Output documents to a wide array of formats like, convert to HTML , rich text for sending emails or any number of other proprietary formats.

We will be using markdown in almost every module's assignment, so it is an important thing to learn here if you don't know already.

Basic working in Markdown

1. Heading

Use # for headings. You can use this like in HTML for H1, H2 etc.

Input:

# H1
## H2
### H3
.
.
###### H6

Output:

H1

H2

H3

.

.

H6

2. Bold,Italics and striking words

Use ** for making text bold and * for italics.

You are required to close the tag here.

Input:

**Bold**
*Italics*
***Bold and Italics Both***
~~this is the striking one~~

Output:

Bold

Italics

Bold and Italics Both

this is the striking one


3. Lists

Use * from new line for unordered list, 1. for order.

You can also use these with proper indentation.

Input:

* Unordered

1. Ordered

* Nested
   1. ordered inside.
      * Unordered inside

Output:

  • Unordered
  1. Ordered
  • Nested
    1. ordered inside.
      • Unordered inside

4. Hyperlinks and images

Use [text](url) for hyperlinks and, ![text](path/url) for image.

You can also use image links by nesting these both.

Input:

[Devincept Website](https://devincept.tech/)

![DevIncept logo image](extras/logo.gif)

[![DevIncept logo image link](extras/logo.gif)](https://devincept.tech/)

Output:

Devincept Website

DevIncept logo image

DevIncept logo image link


5. Coding and notes

  • Use ` for liner codes or highlight.
  • Use ``` for multiline code.
  • Use > to give a note.

You can also use language of code to make the multiline code more realistic, exp: ```python

Input:

    `simple code or highlight`

    > Give a note like this

    ```python
    #simple python multiline code
    a=input()
    c=a
    print (c)
    ```

Output:

simple code or highlight

Give a note like this

#simple python multiline code
a=input()
c=a
print (c)

6. Table

Till now we got to know some important

Input:

|Heading 1|Heading 2| Heading 3|
|---------|---------|----------|
|  Data   |  Data   |  Data    |
|  Data   |  Data   |   Data   |

Output:

Heading 1 Heading 2 Heading 3
Data Data Data
Data Data Data

7. The power of HTML

We have seen the basic features of markdown till now, but superpower of markdown is, You can directly use HTML in it.

Some times it becomes a little difficult to do some complex things in markdown, so using HTML that time can make it work.

Input:

Lists or table inside the table can be implemented using HTML

|Heading 1|Heading 2| Heading 3                                                                  |
|---------|---------|----------------------------------------------------------------------------|
|  Data   |  Data   |  Data<ul><li>Data part 1 </li><li>Data part 2</li></ul>                    |
|  Data   |  Data   |   <table> <th>h1</th><th>h2</th><tr><td>d1</td><td>d2</td></tr></table>    |

Output:

Heading 1 Heading 2 Heading 3
Data Data Data
  • Data part 1
  • Data part 2
Data Data
h1h2
d1d2

7. Emojis to make it ❤️

Use emojis in your repository's Readme to make it Awesome ❗❗❗

Input:

Use anywhere just like 

:bowtie:

:smile:

:heart:

Output:

:bowtie:

😄

❤️

To get the complete list of github markdown emoji markup click here


 

These were the most used Markdown features. These will help you for you assignment in this module as well as in further program, and without markdown your repository on github is just a code-file, start using it now 😉

 

 

Thanks for Reading!!!