Post

Markdown Notes

Posted Updated
Preview Image
By Zheng Yuan
3 min read

Heading

Markdown supports 6 levels of heading with # x n={1, 2, 3, 4, 5, 6}

1
2
3
4
5
6

# Heading 1 
## Heading 2 
### Heading 3 
#### Heading 4 
##### Heading 5 
##### Heading 6

Emphasizing

Italic 

1

This text is *Italic*.

Bold 

1

This text is **Bold**.

Bold and Italic 

1

This text is ***Italic and Bold***.

Strikethrough 

1

This text is ~~Strikethrough~~.

Highlight 

1

I ==love== you so much.

Subscript and Subscript 

1

y = a~1~x^2^ + b~1~

Blockquotes

*Put blank lines before and after lines starting with >.

Blockquotes with one paragraph 

1

> The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

Blockquotes with multiple paragraphs 

1
2
3

> The quick brown fox jumps over the lazy dog.
>
> Waltz, bad nymph, for quick jigs vex.

The quick brown fox jumps over the lazy dog.

Waltz, bad nymph, for quick jigs vex.

Nested Blockquotes 

1
2
3

> The quick brown fox jumps over the lazy dog.
>
>> Waltz, bad nymph, for quick jigs vex.

The quick brown fox jumps over the lazy dog.

Waltz, bad nymph, for quick jigs vex.

List

Ordered list 

1
2

1. First item
2. Second item
  1. First item
  2. Second item

Unordered list 

1
2
3

- First item
- Second item
- 1024\. A lovely number! (escape with \\)
  • First item
  • Second item
  • 1024. A lovely number! (escape with \)

Nested list 

1
2
3
4
5

1. First item
    - Indented item
    - Indented item
2. Second item
3. Third item
  1. First item
    • Indented item
    • Indented item
  2. Second item
  3. Third item

Code 

1
2
3
4
5
6

```<programming_language_name>
Put
	your
		code
			here.
```

Image 

1

![Image_alt_name](image_url)

Horizontal Rule 

1

---

1
2
3

[ZhengYuan - GitHub Page](https://zhengyuan-public.github.io)
<https://zhengyuan-public.github.io>
<fake@example.com>

ZhengYuan - GitHub Page

https://zhengyuan-public.github.io

fake@example.com

Footnotes 

1
2
3
4
5
6
7
8
9
10
11

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.

Here’s a simple footnote,1 and here’s a longer one.2

Task list 

1
2
3

- [x] Get up
- [ ] Take a nap
- [ ] Go to sleep
  • Get up
  • Take a nap
  • Go to sleep

Table

Use three ore more hyphens (-) to create each column’s header;

Use pipes (|) to separate each column;

Use colons (:) to align text.

1
2
3
4

| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |
Syntax Description Test Text
Header Title Here’s this
Paragraph Text And more

YAML header 

1
2
3
4
5
6
7

---
comments: true
title: Markdown Notes
date: 2020-04-05 12:00:00
categories: [programming, markdown, generic]
tags: [programming, markdown, generic]
---

Mathematics 

1
2

When $a \ne 0$, there are two solutions to $(ax^2 + bx + c = 0)$ and they are 
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$.

Collapsible Sections

From this GitHub Page :link:

1
2
3
4
5
6
7
8
9
10
11

<details>
  <summary>Click me</summary>
  
  ### Heading
  1. Foo
  2. Bar
     * Baz
     * Qux

</details>
  • Always have an empty line after the </summary> tag
  • Always have an empty line after each </details> tag
  • *Typora might have some problem rendering it Typora issue #499.

Useful Resources

Markdown Guide - Basic Syntax :link:

Markdown Guide - Extended Syntax :link:

Markdown Cheat Sheet :link:

Complete list of GitHub markdown emoji markup :link:

—>EOF

(Footnotes below)

  1. This is the first footnote. ↩

  2. Here’s one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    { my code }

    Add as many paragraphs as you like. ↩

Programming and Development, Markdown
programming markdown
This post is licensed under CC BY 4.0 by the author.