Use this to make your Readme / Markdowns look good

Use this to make your Readme / Markdowns look good

·

2 min read

This article is not only for beginners but intermediates can read too, to make use of some markdown tags, that will make your Readme professional.

Headings

headings are very useful for not only styling purposes, these are actually used by the Search Engines like GitHub, Google, etc.

in HTML we have headings from H1 to H6, the same way, we've headings in the Markdown. to use it start with one hash (#) with space and provide the heading title.

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

Formating (Bold, Italic, Underline)

**bold text**
_italic text_

Links

Adding a link is very simple, see the format for that.

[link name](https://example.com)

Image

it's similar to adding a link, you just need to put ! before the link format.

![image name](https://image-url)

Alternative

you can also use <img /> tag to add an image, just copy that tag from your HTML, and it will work.

List

list are very simple, in markdown we can create, ordered list & unordered list, here is the format for that.

- list item 1
- list item 2
- list item 3

ordered list

1. item 1
2. item 2
3. item 3

Collapsed section

if you want to show expandable content in markdown here is format for that. it's not supported by all markdowns, but supported in GitHub.

<details>
  <summary> write summary here </summary>

more details here
</details>

Code blocks

you can add your code blocks in markdown, it's better to use code block, instead of images of your code in markdown.


```javascript
    console.log("this is the code");

```