Skip to content

Instantly share code, notes, and snippets.

@Coyas
Forked from coolaj86/markdown-cheatsheet.md
Created March 19, 2021 11:47
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Coyas/47f56b30e80852ed7c98cf9a0cedaa4b to your computer and use it in GitHub Desktop.
Save Coyas/47f56b30e80852ed7c98cf9a0cedaa4b to your computer and use it in GitHub Desktop.

Complete Github Markdown Cheat Sheet

The best parts of the best cheat sheets, in table form! 😃

Table of Contents

Headings ### Heading

Heading

Inline Formatting **bold**
_italic_
`code`
~strike~
bold
italic
code
strike
Emoji Shortcodes :+1: 👍
Block Formatting > a famous quote
a famous quote
Lists - item one
  • item one
    Tables
    | Abc | Def | Ghi |
    | --- | --- | --- |
    | 123 | 456 | 789 |
    AbcDefGhi
    123456789
    Links https://beyondcodebootcamp.com https://beyondcodebootcamp.com
    Images ![](https://amazon.com/favicon.ico)
    Code Blocks
    ```md
    **bold** _italic_ `code`
    ```
    **bold** _italic_ `code`
    Horizontal Rule ---

    Note: That table ^^ is written in Markdown, but contains a lot of escapes and HTML.

    Github Flavored Markdown by Example

    Note: This table is written entirely in pre-rendered HTML

    Headings

    # Heading 1

    Heading 1

    ## Heading 2

    Heading 2

    ### Heading 3

    Heading 3

    #### Heading 4

    Heading 4

    ##### Heading 5
    Heading 5
    ###### Heading 6
    Heading 6
    \## Not a heading ## Not a heading

    Emoji Shortcodes

    :+1: :sparkles: :trophy: 👍 ✨ 🏆
    :tada: :rocket: :metal: 🎉 🚀 🤘
    <span>:</span>+1: :+1:
    All shortcodes

    Inline Formatting

    **bold**
    em**bold**en
    \*\*bald\*\*

    _italic_
    i*tal*ic
    i_tal_ic
    i\*tal\*ic

    ***both***

    ~strikethrough~
    str~ike~through
    str\~ike\~through

    `inline code`
    in`li`ne
    \`inline backticks\`

    ***~`all of the above`~***
    `***~some of the above~***`
    \*\*\*\~\`node of the above\`\~\*\*\*
    bold
    embolden
    **bald**

    italic
    italic
    i_tal_ic
    i*tal*ic

    both

    strikethrough
    strikethrough
    str~ike~through

    inline code
    inline
    `inline backticks`

    all of the above
    ***~some of the above~***
    ***~`node of the above`~***

    Block Formatting

    A paragraph of text.

    A second paragraph,
    with multiple
    lines.

    A paragraph of text.

    A second paragraph, with multiple lines.

    A third paragraph, \
    with line \
    breaks.

    A third paragraph,
    with line
    breaks.

    > A blockquote
    > with attribution - Anonymous
    A blockquote with attribution - Anonymous
    > A blockquote \
    > with line breaks
    A blockquote
    with line breaks
    > a quote
    > > within a quote
    a quote
    within a quote
    \> not a quote > not a quote

    Lists

    - a bulleted (unordered) list
    - with multiple items
        - at multiple nested levels
            - weeee!
    • a bulleted (unordered) list
    • with multiple items
      • at multiple nested levels
        • weeee!
    1. a numbered (ordered) list
    1. with multiple items
        - including unordered items
            - and nested items
    1. a numbered (ordered) list
    2. with multiple items
      • including unordered items
        • and nested items
    1. a numbered (ordered) list
    1. with multiple items
        1. with deeply,
            1. deeply nested numbers
    1. a numbered (ordered) list
    2. with multiple items
      1. with deeply,
        1. deeply, nested numbering
    - [ ] one check
    - [ ] two check
        - no check
            - [x] true check
    \- not a list \
    \- just a paragraph

    - not a list
    - just a paragraph

    Tables

    | Left | Center | Right | Default |
    | :--- | :----: | ----: | ------- |
    | Left | Center | Right | Default |
    | 1    | 2      | 3     | 4       |
    | -    | -      | -     | Multi-<br>line |
    
    Left Center Right Default
    Left Center Right Default
    1 2 3 4
    - - - Multi-
    line
    \|  A  |  B  |  C  | \
    \| --- | --- | --- | \
    \|  1  |  2  |  3  |
    | A | B | C |
    | --- | --- | --- |
    | 1 | 2 | 3 |

    Links & Images

    https://github.com/ https://github.com/
    FOO<https://github.com/>BAR FOOhttps://github.com/BAR
    [Github][github-homepage]

    [github-homepage]: https://github.com/
    Github
    [Github](https://github.com/) Github
    [Github](https://github.com/ "Github Homepage") Github
    ![](https://amazon.com/favicon.ico)
    !["Amazon Favicon"](https://amazon.com/favicon.ico) Amazon Favicon
    https://<span>github</span>.com/ https://github.com/
    \!\[](https://amazon.com/favicon.ico) ![](https://amazon.com/favicon.ico)

    Code Blocks

    ```javascript
    // a function that returns 'hello'
    function greet() {
        return 'hello';
    }
    ```
    // a function that returns 'hello'
    function greet() {
        return 'hello';
    }
    ```txt
    **Look, ma!** It's _Markdown_!
    ```
    **Look, ma!** It's _Markdown_!
    ~~~md
    ```txt
    **Look, ma!** It's _Markdown_!
    ```
    ~~~
    ```txt
    **Look!** It's _Markdown_!
    ```
    ```md
    ~~~txt
    **Look, ma!** It's _Markdown_!
    ~~~
    ```
    ~~~txt
    **Look!** It's _Markdown_!
    ~~~
        ```md
        ~~~txt
        **Look, ma!** It's _Markdown_!
        ~~~
        ```
    ```md
    ~~~txt
    **Look!** It's _Markdown_!
    ~~~
    ```
    \``` \
    not code \
    \```
    ```
    not code
    ```

    Mixed Lists

    - a list with a code block
      ```javascript
      // just a comment
      ```
    - and a blockquote
      > Here's Johnny!
    - and an image
      ![](https://amazon.com/favicon.ico)
    - and even a table
      | a   | b   | c   |
      | --- | --- | --- |
      | 1   | 2   | 3   |
    • a list with a code block
      // just a comment
    • and a blockquote

      Here's Johnny!

    • and an image
    • and even a table
      a b c
      1 2 3

    See Also

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment