Markdown Note

Markdown is a better way to write content for the web. So spending several minutes learning it is beneficial for us.

Markdown Syntax

Italics and Bold

To make a phrase italic in Markdown, you can surround words with an underscore ( _ ).

1
_Writing in Markdown_ is not that hard!

Writing in Markdown is not that hard!

Similarly, to make phrases bold in Markdown, you can surround words with two asterisks ( ** ).

1
**Writing in Markdown** is not that hard!

Writing in Markdown is not that hard!

Headers

As their name implies, they act like titles or subtitles above sections.
There are six types of headers, in decreasing sizes:
To make headers in Markdown, you preface the phrase with a hash mark (#). You place the same number of hash marks as the size of the header you want. For example, for a header one, you’d use one hash mark (# Header One), while for a header three, you’d use three (### Header Three).

1
2
3
4
5
6
# Header one
## Header two
### Header three
#### Header four
##### Header five
###### Header six

headers image

To create an hyperlink link, you wrap the link text in brackets ( [ ] ), and then you wrap the link in parenthesis ( ( ) )

1
Search about [On the way](https://xuxin0612.github.io "welcome to my site")

Search about On the way

Or

1
2
3
Search about [On the way][site]
[site]: https://xuxin0612.github.io

Search about On the way

Images

To create an inline image link, enter an exclamation point ( ! ), wrap the alt text in brackets ( [ ] ), and then wrap the link in parenthesis ( ( ) ).

1
![site-author-image](https://xuxin0612.github.io/uploads/59572399266843.png)

site-author-image

or

1
2
3
![site-author-image][author image]
[author image]: https://xuxin0612.github.io/uploads/59572399266843.png

site-author-image

Alt text is a phrase or sentence that describes the image for the visually impaired.

1
![site-author-image](https://xuxin0612.github.io/uploads/59572399266844.png)

site-author-image

Block Quotes

To create a block quote, all you have to do is preface a line with the “greater than” caret (>).

1
2
3
4
> To create a block quote, all
you have to do is preface a line with the "greater than" caret (>).
To create a block quote, all you have to do is preface a line with the "greater than" caret (>).

To create a block quote, all
you have to do is preface a line with the “greater than” caret (>).

To create a block quote, all you have to do is preface a line with the “greater than” caret (>).

Lists

To create an unordered list, you’ll want to preface each item in the list with an asterisk ( * ).

1
2
3
4
* Milk
* Eggs
* Salmon
* Butter

  • Milk
  • Eggs
  • Salmon
  • Butter

An ordered list is prefaced with numbers, instead of asterisks.

1
2
3
1. carrot
2. cabbage
* lettuce

  1. Crack three eggs over a bowl
  2. Pour a gallon of milk into the bowl
  3. Rub the salmon vigorously with butter
  4. Drop the salmon into the egg-milk bowl

To make a list with more depth, or, to nest one list within another, all you need to do is to indent each asterisk one space more than the preceding item.

1
2
3
4
5
6
7
8
9
* Vegetables
* carrot
* cabbage
* lettuce
* Fruits
* apple
* pear
* mango
* mango juice

  • Vegetables
    • carrot
    • cabbage
    • lettuce
  • Fruits
    • apple
    • pear
    • mango
      • mango juice