[CS] Markdown

(cheat sheets) 2020/05/01 by jean tran

Markdown is la lightweight markup language created in 2004 by John Gruber & Aaron Swartz. Often used to format readme files with file extension .markdown | .md. In 2012 Jeff Atwood and John MacFarlane develop CommonMark an effort of standardization for the common syntax.

Headers

#  Heading 1
## Heading 2
etc...

Lists

Bullet list

* bulletd list item 1
* bulletd list item 2

- bulleted list item 1
- bulleted list item 2

Ordered list

1. ordered list item 1
2. ordered list item 2

1) ordered list item 1
2) ordered list item 2

Tasks | Sub-tasks

1. [ ] Incomplete task
2. [x] Completed task
   - [x] Completed sub-task 1
   - [x] Completed sub-task 2

Text properties

*Italic Text* or _Italic Text_

**Bold Text** or __Bold Text__

~Striked Text~ or ~~Striked Text~~

> text to quote

Link | Image

[Link](https://domain) 
![Image](https://domain/image.png)

Code

Inline code between one backticks: `inline code`
Code block between triple backticks: 
```Swift
   // indented code block
   func myFunc() {
      print("Hello world")
   }
```

Color syntax tips: code block could be suffixed by <language> type after the first triple back ticks without spacing.

Useful references

• Gitlab Flavored Markdown

• Github Flavored Markdown