Skip to main content

Markdown Cheat Sheet


Basic Syntax​

Headings​

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

Text formatting​

  • Wordwrapping

    Info:

    Add an empty line between elements.

  • italic text and more italic text

    *italic text* and _more italic text_

  • bold text and more bold text

    **bold text** and __more bold text__

  • bold and italic text

    ***bold and italic text***

  • Bold Italic Bold

    **Bold *Italic* Bold**

  • strikethrough text

    ~~strikethrough text~~

  • horizontal line: Add 3 dashes

    ---

  • Indentation:

    Info:

    Add 4 spaces


Lists​

    1. ordered
    2. list
    2. ordered
    3. list

  • unordered

    • second
    • third
    - second
    - third

Blockquote & Callouts​

  • normal blockquote

    > normal blockquote

  • nested Blockquote

    nested is better than flat!

    > nested Blockquote
    > > nested is better than flat!

  • nesting with other elements​

    • Simple is better than complex!

    • Complex is better than complicated!

      Beautiful is better than ugly!

      > ## nesting with other elements
      > - Simple is better than complex!
      > - Complex is better than complicated!
      >
      >  *Beautiful* is better than **ugly**!

  • with Emoji

    ℹ Info: Now is better than never.

      > ℹ **Info**: Now is better than never.

    ⚠️ Warning: Be very careful here!

    > :warning: **Warning**: Be very careful here!

  • reference styled links: Github

    ℹ Deklaration somewhere in Document: [identifier] [url]

      [git]: https://github.com/P76ers "P76ers"

    ℹ Usage: [Name][identifier]

    [Github][git]

Images​

  • Image

    Text

    ![Text](https://www.google.de/images/branding/googlelogo/2x/googlelogo_light_color_272x92dp.png)

  • Image with link

    Text

    [![Text](https://avatars.githubusercontent.com/P76ers)](https://github.com/P76ers)

Table of Content​

# This Heading will not be visible in toc <!-- omit in toc -->

- [Basic Syntax](#basic-syntax)
  - [Headings](#headings)
- [Extended Syntax](#extended-syntax)
  - [Emoji](#emoji)

Extended Syntax​

Be aware:

Not all extended syntax features work in all markdown applications.


Comment​

[This is a hidden comment.]: comment

Codeblock​

  • inline const sum = (a, b) => a + bsum(2,2)

    `const sum = (a, b) => a + bsum(2,2)`

  • escaping `backticks` 

    ``escaping `backticks` ``

  • Codeblock

    const sum = (a, b) => a + b;
    sum(2, 2);
    ```js
    const sum = (a, b) => a + b;
    sum(2, 2);
    ```

  • Escaping fenced Codeblock

      ~~~
        ```js
        const sum = (a, b) => a + b
        sum(2,2)
        ```
      ~~~

Emoji​

  • with text

    😂

    :joy:

  • Windows Emoji

    🚀

    Strg .


Footnote​

Here's a sentence with a footnote. 1

Here's a sentence with a footnote. [^1]

Info:

Footnote is at bottom of Page!


[^1]: This is the footnote.

Heading ID​

### My Great Heading {#custom-id}

Table​

PackagesDescriptionVersion
left alignmiddle alignright align
1.01.01.0
| Packages   | Description  |     Version |

| :--------- | :----------: | ----------: |

| left align | middle align | right align |

| 1.0        |     1.0      |         1.0 |

Task List​

  • Task 1

  • Task 2

  • Task 3

    [x] Task 1
    [ ] Task 2
    [ ] Task 3

Toggle​

This is a toggle!
Contents of toggle.
<details>
  <summary> This is a toggle!</summary>

  Contents of toggle.
</details>

Youtube​

  • embed Video

    Thumbnail

    [![Text](ImageUrl)](VideoUrl)

    [![Thumbnail](https://i.ytimg.com/an_webp/fzI9FNjXQ0o/mqdefault_6s.webp?du=3000&sqp=CMyblqQG&rs=AOn4CLACPdIqbUwWoAWJbmuGyNNuytgV1A)](https://youtu.be/fzI9FNjXQ0o)

  1. This is the footnote.↩