Important Links
Getting Started!
In this section, we’ll explore Markdown syntax from basic to advanced. Whether you’re writing a simple note, a project README, or full documentation, understanding how to use Markdown properly will make your content clean, structured, and professional.
Headings
We use # symbol to create headings, number of # symbol represents heading level, ranging from 1 (largest) and 6
(smallest) in markdown.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Paragraphs
We write normally to create a paragraph and leave a blank line to start a new paragraph in markdown.
Hello World, We are learning Markdown Syntax.
Markdown syntax is very easy to learn.
Bold
We create bold text using double asterisk ** or double
underscore __ in markdown.
**Hello World, This is Bold Text**
__Hello World, I am Bold text too__
Italic
We create italic text using single asterisk * or single
underscore _ in markdown.
*Hello World, This is Italic Text*
_Hello World, I am Italic text too_
Bold & Italic
We create Bold & Italic text using triple asterisk *** or triple
underscore ___ in markdown.
***Hello World, This is Bold & Italic Text***
___Hello World, I am Bold & Italic text too___
Ordered Lists
We use numbers i.e. 1., 2., 3. etc to create ordered lists in markdown.
1. HTML
2. CSS
3. JavaScript
Unordered Lists
We use these symbols i.e. -, *,
+ etc to create unordered lists in markdown.
- HTML
* CSS
+ JavaScript
Code Block
We use backticks i.e. ` for line code blocks and triple
backticks i.e. ``` for block code in markdown.
`let markdownEle = "Hello, I am inline code block";`
```
function blockCodeEle() {
console.log("Hey, I am Block Code Element");
}
blockCodeEle();
```
Horizontal Line
We use three or more dashes ---, asterisk *** or underscore ___ to create a
horizontal line in markdown.
There is a horizontal line below using dashes
---
There is a horizontal line below using asterisk
***
There is a horizontal line below using underscore
___
Inline Links
We use [text](url) to create inline links in markdown.
[Google](https://www.google.com/)
Reference Links
We use [text](reference) to create reference links in markdown.
[Google][1]
[1]: https://www.google.com/
Linking Files
We use standard markdown link syntax i.e. [link Text](filepath)
with the file path or URL to link a file path in markdown.
[Download PDF Guide](assets/guide.pdf)
[Download Project Brief](files/project-brief.docx)
Tables
We use pipes i.e. | and dashes i.e. - to create a table in markdown.
| Items | Quantity(in KG) | Price |
|-----------|-------------------|-----------|
| Apple | 2kg | ₹100 |
| Mango | 4Kg | ₹250 |
| Cherry | 1kg | ₹80 |
| Banana | 4kg | ₹120 |
Task Lists
We use - [ ] for unchecked items and use - [x] for checked items in markdown.
- [x] Chant Shrimad Bhagavad Gita Daily
- [x] Chant Shri Hanuman Chalisa Daily
- [x] Feed Cow Daily
- [ ] Respect Elders
Note: To view output of markdown, you have to install markdown preview extension in your visual studio code.
Foot Notes
We use [^identifier] in the text and [^identifier]: for the footnote in markdown.
This is the sentence with footnote[^1]
[^1]: This is the footnote content.
Mentions
We use @username to mention github user in markdown.
Hey, I am Prem Kumar Rajbhar, My username is @premkrrajbhar on Github.
Note: GitHub does not notify users when they are mentioned in a README.md file. Mentions are only clickable (link to profile), not notified.
Emojis
We use :emoji_name: or directly copy the emoji and paste in the
markdown file.
Hey Developers :wave:, How are you?
I am here to guide you to learn markdown 😇
HTML in Markdown
Markdown supports HTML tag such as details and summary tag.
HTML
HyperText Markup Language
Note: If you don't know about detail and summary tag then you can learn it from mdn web doc website.
Table of Contents
We create a Table of Contents in Markdown by listing links with [text](#anchor) that point to headings for easy navigation.
# Table of Content:
- [Introduction of Markdown](#introduction-of-markdown)
- [Why use Markdown](#why-use-markdown)
### Introduction of Markdown
Markdown is a lightweight markup language used to format plain text using simple, readable symbols.
### Why use Markdown
Developers use Markdown to keep their documentation clean, versionable, and readable.
### Origin and Creator
Markdown was created in 2004 by John Gruber
Strikethorugh
We use ~~ before and after the text indicate that something has
been removed or is no longer relevant in markdown.
~~Hello, This is Strikethorugh example~~
Comments
We use HTML comment syntax <!-- comment --> to add
comments in Markdown, which are not shown in the rendered output.
<!--This is Comment-->
Try it Now
Now that you’ve learned Markdown and its syntax, it’s time to put it into practice. Below are some online tools where you can create and preview your first Markdown documents.