This content originally appeared on DEV Community and was authored by Abayomi Ogunnusi
Written by: Abayomi Ogunnusi
According to the official site definition. Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages.
This is the basics of clear communication used in most version control and collaborative platforms such as Github.
In this post I will be giving a summary of the commonly used markdown syntax. For clarity sake, the raw format are written above and the output of the markdown are written below.
Headings are written with hashtags. One '#' is equivalent to the 'h1' in HTML syntax and so on.
# h1
## h2
### h3
#### h4
##### h5
###### h6
h1
h2
h3
h4
h5
h6
Lists
lists can be written with - or * or + sign symbols.
## Unordered list
- first time
- first time
Unordered list
- first time
- first time
or use:
* item 1
* item 2
* item 3
- item 1
- item 2
- item 3
Nested list using hyphen. Always ensure you put space after the hyphen
- first time
- first time
- second time
- first time
- first time
- second time
Progress list
- [ ] item 1
- [ ] item 2
- [ ] item
- [ ] item 1
- [ ] item 2
- [ ] item
check list or task list
- [x] item 1
- [x] item 2
- [x] item 3
- [x] item 1
- [x] item 2
- [x] item 3
The above list could also be written as
* [x] item 1
* [x] item 2
* [x] item 3
- [x] item 1
- [x] item 2
- [x] item 3
Ordered list
1. item 1
2. item 2
- item 1
- item 2
GitHub list: Reordering occurs automatically
1. item 1
1. item 2
1. item 3
- item 1
- item 2
- item 3
Links
[this contain the link description](this contains the actual link)
Links with title
[this contain the link description](this contains the actual link "this contains the link alt text")
Inline code using the backtick
this is an inline `code`
this is an inline code
Block of codes use three surrounding back ticks used in writing specific language syntax. Ensure to put the language immediately after the backtick as shown below.
<p> a paragraph example</p>
<p> a paragraph example</p>
let table = 3;
Before and after results using block quotes
Before
console.log('test')
after
console.log('new test')
the above code block can be re-written as :
-console.log('test`)
+console.log('new test`)
console.log('neutral')
diff
-console.log('test))
+console.log('new test
console.log('neutral')
Block quotes
> this is a block quote
this is a block quote
Adding pictures
Emphasis (strong)
this is a bold **text**
or __bold__
this is a bold text
or bold
Emphasis (italics)
This is an *italics*
or
_italics_
This is an italics
or
italics
Writing language syntax using markdown
function add(a,b){
return a + b;
Tables
| User | Email |
| --- | --- |
| abayomi | abayomiogunnusi@gmail.com |
| isreal | isreal@gmail.com |
| User | |
|---|---|
| abayomi | abayomiogunnusi@gmail.com |
| isreal | isreal@gmail.com |
Tables
| Frond-End | Back-End | Full Stack |
|---|---|---|
| HTML, CSS, JS | NODE JS, MONGODB | HTML, MONGODB,... |
| REACT, BOOTSTRAP | EXPRESS, MONGOOSE | DOCKER |
strike through is achieved using ~~ ~~
~~strike~~
strike
Checklist
- [ ] abayomi
- [ ] abayomi
- [ ] abayomi
- [ ] abayomi
- [x] abayomi
- [ ] abayomi
- [ ] abayomi
- [ ] abayomi
- [ ] abayomi
- [x] abayomi
Tag people use the '@' symbol
@wowzone
@deenn
@drsimplegraffiti
drsimplegraffiti
/
drsimplegraffiti
Config files for my GitHub profile.
Hi ?, I'm Abayomi
A passionate developer from Nigeria
-
?? All of my projects are available at drsimplegraffiti.github.io
-
? How to reach me abayomiogunnusi@gmail.com
-
⚡ Fun fact I'm an alien
Connect with me:
Languages and Tools:
This content originally appeared on DEV Community and was authored by Abayomi Ogunnusi
Abayomi Ogunnusi | Sciencx (2021-06-07T10:06:31+00:00) Mark Down for Newbies. Retrieved from https://www.scien.cx/2021/06/07/mark-down-for-newbies/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.