DEV Community

Ansh00
Ansh00

Posted on

HOW TO USE MARKDOWN BASIC:-

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. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

You can use Markdown most places around GitHub:

Gists
Comments in Issues and Pull Requests
Files with the .md or .markdown extension.

Basics of Markdown

Markdown is the most popular markup language that can be used to format documents. It can be used to create websites,ebooks,email,chats in discussions forums.

Topics

  • Paragraphs

    MD expects a full line space to show texts in a different line else it joins text in the same line.

  • Text decorations

    MD can write bold texts, italiic italic texts

  • Headings

    No of #'s represent the type of heading. Github will automatically add id's to headings, so the text will be automatically linked.

    This is h2

    This is h3

    You can use one # all the way up to ###### six for different heading sizes.

  • Links

My Github account.[Anshul] github repo.

  • Images

    Images can be used just like links. Alt txt

    "Dog Img"

    Thumbnails images can also be used which links to larger image

    • ### Ordered and Unordered Lists

    Coding Best Practices:

    • Keep code DRY
    • Writing Unit Test cases
    • Checking cross-browser support

    Steps to merge branch:

  1. Create a branch from feature
  1. commit your changes
  1. push your changes
  1. raise a pull request
Enter fullscreen mode Exit fullscreen mode
  • Code Blocks

    This is super helpful when posting any code snippet

    const fn = () => alert("some fn");
    
```css
.hide {
    display:none
}
```
Enter fullscreen mode Exit fullscreen mode
Also can show code difference
Enter fullscreen mode Exit fullscreen mode
```diff
var x = 10;
- const counter = 0;
+ let counter = 0
```
Enter fullscreen mode Exit fullscreen mode
  • Tables

    Tables can be generated with headings and text alignment option

    Stocks Price
    APPLE 4000
    REALME 500
  • Blockquotes

    As Kanye West said:

We're living the future so
the present is our past.

  • Inline code

    I think you should use an
    <addr> element here instead.

  • Task Lists

  • [x] @mentions, #refs, links, formatting, and tags supported

  • [x] list syntax required (any unordered or ordered list supported)

  • [x] this is a complete item

  • [ ] this is an incomplete item

Cool Tips

  • ScreenTOGif to record videos in GIF format
  • Upload GIF's to giphy to embed them into blog posts.

Extras:-

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @ansh — love your sweater!

But I have to admit, tasks lists are my favorite:

  • [x] This is a complete item
  • [ ] This is an incomplete item

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji!

Meet me on

DEV:-Dev

GITHUB:-Github

LINKEDIN:-Linkedin

Top comments (0)