| Style |
Syntax / Description |
| Heading/Title |
Add single # for Heading size 1, ## for Heading 2, …, ###### for Heading 6. Where 1 is the biggest and 6 is smallest header.
E.g.:
#This is the title of the article |
| Bold |
Add 2 ** before and after the word/character
E.g.:
This text in **bold** |
| Italic |
Add 1 * before and after the word/character
E.g.:
This text in *italics* |
| Bold & Italic |
Add 3 *** before and after the word/character
E.g.:
This text in ***bold and italics*** |
| New Line & Line Breaks |
Add a \ before and after a paragraph to insert line gap.
Also, for creating line breaks before paragraph using \ |
| Horizontal Rules |
Add any of these symbols after an empty line *** or --- or ___ |
| Ordered lists |
Add numbers in any order with a number, a dot and a space
E.g.:
1. |
| Unordered lists |
Add any of the following symbol - or + or *
E.g.:
- list item 1
- sub list item 1
+ list item 2
* list item 3 |
| Table |
Add a pipe symbol before the start and end | heading |
First row will be considered as heading followed by horizontal rules with pipe in the second row (to highlight the heading).
E.g.:
| Header 1 | Header 2 |
| ----------- | ---------- |
| data row 1 | data row 1 |
| data row 2 | data row 2 | |
| Images |
To add images, add ! followed by box brackets and image location hyperlink within parenthesis.
E.g.:
 |
| Block quotes |
To create a new blockquote add this symbol > on new line on first column |
| Nested quotes |
Add the same symbol twice >>to create a nested block |
| Code blocks |
An indent with 4 spaces or 1 tab creates a code block |
| Fenced code blocks |
Adding 3 ``` (backticks) or 3 ~~~ will create a fenced code block.
Also, language can be specified to make the rendering engine understand and format the line of code
E.g.:
```json |
| Link Titles |
Put the text in box brackets immediately followed by URL within the parenthesis
To add onhover text, add a space and the description within double quotes next to hyperlink URL
E.g.:
[Google](https://www.google.com)
[Google](https://www.google.com "search engine for all needs") |
| Link URLs |
To display URL, add the hyperlink within the arrow brackets. Specifying email address within arrow brackets will make the hyperlink type as “mail-to”
E.g.:
<https://www.google.com>
<[email protected]> |
| Link Images |
As we know adding ! immediately followed by box brackets with text acting as ALT TEXT and image URL within parenthesis Optionally description can be added for image onhover
This image set in box brackets immediately followed by hyperlink URL within parenthesis makes the image hyperlinked
E.g.:
[](https://www.google.com) |
| Footnote |
Adding ^ to the reference link creates the footnote
E.g.:
Sample footnote created.[^1]
[^1]: This is the footnote |
| Strikethrough |
Adding 2 ~~ will create a strikethrough
E.g.:
This will ~~strikethrough~~ the word in between |
| Highlight |
To highlight a word or sentence, double equal == between the word or if application supports then add html supported tag <mark>
E.g.:
In this line, this word ==highlight== will be highlighted.
In this line, this word <mark>highlight</mark> will be highlighted. |
| Subscript |
To create subscript, Single tilde ~ between the word or if application supports then add the tag <sub>between the word
E.g.:
H~2~O
H<sub>2</sub>O |
| Superscript |
Single backtick ^ between the word or if application supports then add the html supported tag <sup>
E.g.:
X^2^
X<sup>2</sup> |
| Escaping characters |
If any of the special characters (\ ` * _ { } [ ] < > ( ) # + - . ! |)are used in the paragraph then to escape the Markdown processing use \
E.g.:
\* Conditions apply |