Markdown is a simple markup language for creating formatted text in a plain-text editor. Conventionally, readme files are written in markdown and saved with the .md extension. Github looks for a readme.md file and displays it under the bottom of the code tab of a repository.
Simple examples are given below for:
Heading are indicated with # signs, which correspond to h1, h2, … , h6 in html.
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6
Bold & Italic
Single *Asterisks* or _underscore_ on each side of the word makes it italic, Double **asterisks** or __underscores__ make it bold, Triple ***asterisks*** or ___underscores___ make it italic and bold.
Single Asterisks or underscore on each side of the word makes it italic,
Double asterisks or underscores make it bold,
Triple asterisks or underscores make it italic and bold.
You can put the link [inline](https://www.google.com) or put the link in angle brackets like so <https://cacarer.com>.
Bulleted Lists (unordered list in html) can be made using: * asterisks - minuses + or pluses + Just put a tab to make a sublist item. Ordered lists can be made using numbers followed by a period: 1. Numbers, any numbers, 1. and they will be displayed ordered 2. as an <ol> element in html.
Bulleted lists (unordered list in html) can be made using:
- or pluses.
- Just put a tab to make a sublist item.
Ordered lists can be made using numbers followed by a period:
- Numbers, any numbers.
- and they will be displayed ordered
- as an <ol> element in html.
You can add a picture with Profile as the alt text using: ![Profile](https://cacarer.com/wp/wp-content/uploads/2021/03/profile.jpg)
You can add a picture with Profile as the alt text using:
These are only the simples use cases for writing a basic Readme.md file. You can make links and images with titles, add links with references, mix and match ordered and unordered lists, add tables, highlight codes and much more. These advanced uses can be found at this cheat sheet written by Adam Pritchard on GitHub.