Skip to content

Latest commit

 

History

History
executable file
·
180 lines (150 loc) · 3.73 KB

Markdown.md

File metadata and controls

executable file
·
180 lines (150 loc) · 3.73 KB
Raw

Markdown Cheat Sheet

Index

General Notes

  • In most cases, you can use HTML tags to define the style of markdown text.
  • Listed here are the basic elements of Markdown. This is not an exhaustive list.

Headings

  • Default

    Heading 1

    Heading 2

    Heading 3

    Heading 4

    Heading 5
    Heading 6
  • With formatting

    Heading 1

    Heading 2

    Heading 3

Text Formatting

  • Non-HTML
    • Bold
    • Italics
    • Strike-through
  • HTML
    • Bold
    • Italics
    • Underlined

Lists

  • Unordered (Item 1)
  • Unordered (Item 2)
  • Unordered & nested (ordered)
    • Item 1
    • Item 2
    • Item 3
  1. Ordered (Item 1)
  2. Ordered (Item 2)
  3. Ordered & nested (ordered)
    1. Numbered item 1
    2. Numbered item 2
    3. Numbered item 3
  4. Ordered & nested (unordered)
    • Unordered item 1
    • Unordered item 2
    • Unordered item 3

Check-lists

  • Checked item 1
  • Unchecked item 2

Links / URL's

Link 1 - DuckDuckGo
Link 2 - GitHub

Image & HTML

Image
Photo by Wil Stewart on Unsplash

Code Blocks

  • Bash

    pacman -Sy

  • Python

    print('Hello, world!')

  • HTML

    <html>
  <head>
      <title> HTML in Markdown </title>
  </head>
  <body>
      <div id='main'> Hello, world! </div>
  </body>
</html>

  • Difference

    + This line was added
- This line was removed

Inline Code Block

<hr> Everything within a code block is printed as-is on the screen.
<br> Hello, World! <br>

Tables

Note:

  • :--- means left-align
  • :---: means center-align
  • ---: means right-align
Header 1 Header 2 Header 3
Item 1.1 Item 1.2 Item 1.3
Item 2.1 Item 2.2 Item 2.3
Item 3.1 Item 3.2 Item 3.3

Quotes

Quote 1

Quote 2

Quote 3

Quote 4

Quote 5

Quote 6

Detail pane (collapsible)

Title Line 1
Line 2

Link to a section

  • This allows us to create a hyperlink that links to a particular portion of the same document.
    Rules - The link must start with a #.
    - All the words must be in lowercase.
    - Use `-` for all delimiters like spaces, symbols, etc.

Image

Mathematical Symbols

Note: Enclose general expressions with $

Exponent: $a^2 + 2b = 2$

Comparison: $a &lt; 2$ and $b &gt; 2$

Comparison: $c \leq 2$ and $d \geq 2$

Bar: $A ⊕ B = A \bar B + \bar AB$

Sub-script: $c_1=2$ and $c_2 \leq 1$

Go back to Topic #1