Markdown Basics
Because we forget, we write. I created this blog mainly as a memo, keeping track of what I have learned and what I am becoming interested in. Since the posts will be generated using Markdown, I guess it is a good starting point to put down some tips for markdown usage. OK, Let’s us get started.
More about Markdown is available in Writing in GitHub.
Headings
Headings are ranked using #. More #, lower rank and smaller size.
1 | # H1 |
H1
H4
Text Styles
1 | *Italic* |
Italic (_ works the same as *)
BoldStrikethrough
Links
URLs will be automatically highlighted as links. For example, https://caizkun.github.io .
Moreover, you can insert a link as follows:
1 | [Cai's Blog](https://caizkun.github.io "Mouse Hover Text") |
Images
1 |  |

Code
Inline codes are embraced with back-ticks ` `.
For example, std::cout << Hellow World! << std::endl;
Code blocks are embraced with three back-ticks at both ends and syntax highlighting is enabled.
1 | ```Cpp |
1 | // C++ is awesome! |
1 | ```Java |
1 | // Java is cool! |
Quotes
1 | > "Pain is inevitatble. Suffering is optional." |
“Pain is inevitatble. Suffering is optional.”
–Haruki Murakami, What I Talk About When I Talk About Running
Lists
1 | 1. Ordered Item1 |
Ordered Item1
- Sub Unordered Item1a (note the indentation)
- Sub Unordered Item1b
Ordered Item2 (numbering continued correctly, the leading number doesn’t matter)
Ordered Item3 (one blank line doesn’t stop the numbering)
- New Ordered Item1 (two or more blank lines starts a new numbering)
Tables
Tables can be created by using - and | to aggregate words. : can be used to align text.
1 | | Pred\Obs | True | False | |
| Pred\Obs | True | False |
|---|---|---|
| True | 2032 | 23 |
| False | 50 | 195 |