Markdown Basics

Good Referrences

简书官方教程

A YouTube Tutorial

Vscode + markdownlint + Auto-Open Markdown Preview

Syntax Essentials

  1. Headings

    code:

    1
    2
    3
    4
    # Heading1
    ## Heading 2
    ### Heading 3
    ...

    effects:

    Heading1

    Heading2

    Heading3

  2. Italics

    code:

    1
    2
    *this text* is italic
    _this text_ is italic

    effects:

    this text is italic

    this text is italic

  3. Strong

    code:

    1
    2
    **this text** is strong
    __this text__ is strong

    effects:

    this text is strong

    this text is strong

  4. Strikethrough

    code:

    1
    ~~this text~~ is striked through

    effects:

    this text is striked through

  5. Horizontal Rule

    code:

    1
    2
    ---
    ___

    effects:

  6. Blockquote

    code:

    1
    >this text is a blockquote

    effects:

    this text is a blockquote

  7. Links

    code:

    1
    2
    3
    [linkname](link-url)
    <!-- with title-->
    [linkname](link-url "titlename")

    effects:

    william’s-blog

    william’s-blog

  8. Unordered List

    code:

    1
    2
    3
    4
    * Item 1
    * Item 2
      * Nested Item 1
      * Nested Item 2

    effects:

    • Item 1
    • Item 2
      • Nested Item 1
      • Nested Item 2

  9. Ordered List

    code:

    1
    2
    3
    4
    1. Item 1
    2. Item 2
    3. Nested Item 1
    4. Nested Item 2

    effects:

    1. Item 1
    2. Item 2
    3. Nested Item 1
    4. Nested Item 2

  10. Code Blocks

    code:

    1
    2
    3
    4
    5
    `<p>This is an inline code block</p>`
    <!-- get rid of '\' while implementing-->
    \`\`\`language-name
    import numpy as np
    \`\`\`

    effects:

    <p>This is an inline code block</p>

    1
    import numpy as np

  11. Images

    code:

    1
    ![Markdown Logo](https://markdown-here.com/img/icon256.png)

    effects:

    Markdown Logo

  12. Task List

    code:

    1
    2
    3
    * [x] Task1
    * [x] Task2
    * [ ] Task3

    effects:

    • Task1
    • Task2
    • Task3

  13. Tables

    code:

    1
    2
    3
    4
    5
    | Tables        | Syntax        | Are           |
    | ------------- |:-------------:| -------------:|
    | col 3 is      | "----------:" | right-aligned |
    | col 2 is      | ":---------:" | centered      |
    | col 1 is      | "-----------" | left-aligned  |

    effects:

Tables Syntax Are
col 3 is “———-:” right-aligned
col 2 is “:———:” centered
col 1 is “———–” left-aligned