By /

Markdown Language — Readme.md

By Moazzam Ali and Muhammad Ramzan

  1. Markdown

    2. Markdown is a lightweight markup language used to format text. Its primary purpose is to make writing and reading formatted documents simple, especially for documentation, readmes, and technical content.

    File Extension: Markdown files typically have the extension .md or .markdown

    Common Use Cases:

    • Documentation: Describing how a project works.
    • Readmes: Providing an overview of a repository.
    • Changelogs: Tracking changes in projects.
    • Wikis: Collaborative project documentation.

    Open Preview in VS-code:

    When you open the readme or markdown file in the VS-code, in the top right side of VS-code you can see such an icon, click on icon readme file preview will be opened.


  2. Headings

    3. Example:

    To create a heading, add one to six # symbols before your heading text. The number of # you will determine the hierarchy level and typeface size of the heading.

    # Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

    Output:

  3. Paragraphs

    4. Example:

    This is a paragraph.


Leave a lank line to separate paragraphs.

    Output:

  4. Text Styles

    5. Example:

    **Bold Text** 
*Italic Text* 
***Bold and Italic***

    Output:

  5. Lists

    6. Unordered List:

    - Item 1
- Item 2
- Sub-item

    Output:

    Ordered List:

    1. Step 1
2. Step 2
  1. Sub-step

    Output:

  6. Code Blocks

    7. Inline Code:

    Use `backticks` for inline code.

    Output:

    Quoting code:

    Some basic Git commands are:
```
git status
git add
git commit
```

    Output:

  7. Links

    8. Example:

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

    Output:

  8. Images

    9. Example:

    ![GitHub-Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)


![GitHub-Logo](path-to-file/GitHub-Mark.png)
            
            
<p align="center">
<img width=200 height=200 src='image-link or path-of-image'>
</p>

    Output:

  9. Tables

    10. Example:

    | Feature    | Description             |
|------------|-------------------------|
| Simplicity | Easy to write and read  |
| Versatile  | Works in many platforms |

    Output:

  10. Checklists

    11. Example:

    - [x] Task 1 (Completed)
- [ ] Task 2 (Pending)

    Output:

  11. Emojis

    12. Example:

    Use emojis for fun: :smile: :rocket: :+1:

    Output:

Reference:


Scroll to Top