Skip to content

this file shows the reamde file styling demonstarion

License

Notifications You must be signed in to change notification settings

Lan5880/Readme-Guide

 
 

Repository files navigation

linkedin

headings

# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6

Emphasis

*this text will be itallic*
_This text will also be italic_

**This text will be bold**
__This text will also be bold__

~~this will be the strikethrough~~

example: this text will be itallic This text will also be italic

This text will be bold This text will also be bold

this will be the strikethrough

List

Ordered List

1. One
2. Two
3. Three
  1. One
  2. Two
  3. Three
Another way to Create Ordered list
1. item
1. item
1. item
  1. item
  2. item
  3. item

nested list

1. Item 1
2. Item 2
3. Item 3
   1. SubItem 1
   2. SubItem 2
   3. SubItem 3
  1. Item 1
  2. Item 2
  3. Item 3
    1. SubItem 1
    2. SubItem 2
    3. SubItem 3
Another way for nested list
1. Item 1
1. Item 2
1. Item 3
   1. SubItem 1
   1. SubItem 2
   1. SubItem 3
  1. Item 1
  2. Item 2
  3. Item 3
    1. SubItem 1
    2. SubItem 2
    3. SubItem 3

Unordered List

* this will be the ordered list
* just put a start in the begning of the line 
* and add some *Space* between `*` and the content
  * this will be the sub points
  * just add  two _space_ in next line,
  * add the `*` Sympol and the _context_

Example:

  • this will be the ordered list
  • just put a start in the begning of the line
  • and add some Space between * and the content
    • this will be the sub points
    • just add two space in next line,
    • add the * Sympol and the context Alternatively,
- you can use `-` Symbol 
- and your _unordered_ list works well
  - if you hav  sub list , add two spaces before the dash or star
  - just like this 

Example:

  • you can use - Symbol
  • and your unordered list works well
    • if you hav sub list , add two spaces before the dash or star
    • just like this

Links

Syntex: [link text](link)
[google](www.google.com)

Screenshots

Syntex: ![Image Name](image location)
![website_logo](/images/logo.png)

Inline code

you can use `<addr>` for highlighting some codes

you can use <addr> for highlighting some codes

Blockquotes

As i said:
> this cheatsheet will definitely helps you
> in building your readme.md file better

As i said:

this cheatsheet will definitely helps you
in building your readme.md file better

Bonus github Flavoured markdown

for highlighting your syntex

```javascript
()=>
{
return max.num
}```

Task Lists

- [x] you can use this to mention your completed and incompleted tasks
- [x] this is a complete task
- [] this is incomplete task
  • you can use this to mention your completed and incompleted tasks
  • this is a complete task
  • [] this is incomplete task

Tables

you can create tables by assebling a list of words and dividing them with - (for the first row), and then separating each column with a pipe |:

first heading | second heading
---------------|----------------
this is cell 1| this is cell 2
this is another cell | and this is another
this is cell 4|this is cell 5

example:

car Company Country
Tata India
Toyota Japan
NIssan Japan
Audi Germany
BMW Germany
Rolls Royce United Kingdom
Lamborghini Italy

Mentions

Type @ symvol, followed by a username, will notify that person to come and view the comment. this is called an "@mention", you can also @mention teams within an Organisation.

Automatic linking foe Urls

Any url ( like https://github.com/Angryl) will be automatically converted into a clickable link.
like this - https://github.com/Angryl

for more refer to official Documentation

About

this file shows the reamde file styling demonstarion

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published