This is a cheatsheet to refer to when creating projects with brief writeup / setup guides.
This is a bold text. Alternatively, you can also bold text like this.
This is a italic text.
You can combine bold and italic text like this.
This is a strikethrough text.
Unordered list can use:
- Asterisk Sign "*"
- Minus Sign "-"
- Plus Sign "+"
You can create blockquotes (a line separator at the left hand side) using the ">" symbol. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam fermentum lorem quam, nec maximus magna sollicitudin ut. Vestibulum varius quam elit, ac tempus dui iaculis vel. Mauris et suscipit nibh.
You can create table by using the "|" pipe symbol together with the header separator "----" or ":---:" (for center-aligning) .
The table row contents need not be aligned with spacing like the title. You can just compact it.
NAME: varchar |
USERNAME (p_key): varchar |
PASSWORD: varchar |
BALANCE: number |
---|---|---|---|
Nico Robin | nico_robin | password123 | 1000 |
Tony Chopper | tony_chopper | asdf123 | 2000 |
Sanji Vinsmoke | sanji_vinsmoke | dragon123 | 3000 |
Zoro Rorona | zoro_rorona | sword123 | 4000 |
You can include line code like this pip install pandas
in a paragraph using backticks.
Alternatively, you can write block codes in paragraphs using the triple backticks like this:
private String username;
private String password;
You can also include syntax highlighting for specific programming languages (need check which are supported) or other code related stuff (E.g. HTTP headers) as shown below:
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
URLs and URLs in angle brackets will automatically get turned into links. http://www.google.com or http://www.google.com and sometimes google.com (but not on Github, for example).
Inline-style link with title when hover
Relative reference to a repository file
Using normal hyperlink with hover (hover to see the title text):
Using html tag: