NathanSWard / markdown-cheatsheet

Markdown Cheatsheet for Github Readme.md

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Markdown Cheatsheet


Heading 1

Markup :  # Heading 1 #

-OR-

Markup :  ============= (below H1 text)

Heading 2

Markup :  ## Heading 2 ##

-OR-

Markup: --------------- (below H2 text)

Heading 3

Markup :  ### Heading 3 ###

Heading 4

Markup :  #### Heading 4 ####

Common text

Markup :  Common text

Emphasized text

Markup :  _Emphasized text_ or *Emphasized text*

Strikethrough text

Markup :  ~~Strikethrough text~~

Strong text

Markup :  __Strong text__ or **Strong text**

Strong emphasized text

Markup :  ___Strong emphasized text___ or ***Strong emphasized text***

Named Link and http://www.google.fr/ or http://example.com/

Markup :  [Named Link](http://www.google.fr/ "Named link title") and http://www.google.fr/ or <http://example.com/>

heading-1

Markup: [heading-1](#heading-1 "Goto heading-1")

Table, like this one :

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

code()

Markup :  `code()`
    var specificLanguage_code = 
    {
        "data": {
            "lookedUpPlatform": 1,
            "query": "Kasabian+Test+Transmission",
            "lookedUpItem": {
                "name": "Test Transmission",
                "artist": "Kasabian",
                "album": "Kasabian",
                "picture": null,
                "link": "http://open.spotify.com/track/5jhJur5n4fasblLSCOcrTp"
            }
        }
    }
Markup : ```javascript
         ```
  • Bullet list
    • Nested bullet
      • Sub-nested bullet etc
  • Bullet list item 2
 Markup : * Bullet list
              * Nested bullet
                  * Sub-nested bullet etc
          * Bullet list item 2
  1. A numbered list
    1. A nested numbered list
    2. Which is numbered
  2. Which is numbered
 Markup : 1. A numbered list
              1. A nested numbered list
              2. Which is numbered
          2. Which is numbered
  • An uncompleted task
  • A completed task
 Markup : - [ ] An uncompleted task
          - [x] A completed task

Blockquote

Nested blockquote

Markup :  > Blockquote
          >> Nested Blockquote

Horizontal line :


Markup :  - - - -

Image with alt :

picture alt

Markup : ![picture alt](http://www.brightlightpictures.com/assets/images/portfolio/thethaw_header.jpg "Title is optional")

Foldable text:

Title 1

Content 1 Content 1 Content 1 Content 1 Content 1

Title 2

Content 2 Content 2 Content 2 Content 2 Content 2

Markup : <details>
           <summary>Title 1</summary>
           <p>Content 1 Content 1 Content 1 Content 1 Content 1</p>
         </details>
<h3>HTML</h3>
<p> Some HTML code here </p>

Hotkey:

⌘F

⇧⌘F

Markup : <kbd>⌘F</kbd>

Hotkey list:

Key Symbol
Option
Control
Command
Shift
Caps Lock
Tab
Esc
Power
Return
Delete
Up
Down
Left
Right

Emoji:

❗ Use emoji icons to enhance text. 👍 Look up emoji codes at emoji-cheat-sheet.com

Markup : Code appears between colons :EMOJICODE:

About

Markdown Cheatsheet for Github Readme.md