What is Markdown

• a lightweight markup language with a plain text formatting syntax
• can be converted to html/xhtml and other formats
• it's main purpose is readability and ease of use

What is it used for?

• README files (Github)
• Forum and Blog Posts
• Static sites generators
• Presentations

What can we format with MD?

• Headings
• Lists
• Emphasis
• Links
• Blocks of code
• Images
• Quote blocks
• Horizontal rules

What do I need to run markdown

• any text editor is good for markdown, choose one with extensions to see live preview of the file (es. vs code)
• or a Chrome extension Markdown Viewer for local/remote files

How to I comment in a markdown file?

• html comments are compatible with markdown

Headings

• Use hashtag to add heading levels (from one to six #,##,###,####,#####,######)

Italics

• To use italics we have two options:
  1. Use asterisk this is italics
  2. Use underscores this is italics too

Strong

• To use bold characters we also have two options:
  1. Use double asterisk this is a bold statement
  2. Use double underscores this is a blunt one too

Strikethrough

• To strike characters we use double tilde

Horizontal Rule

• An horizontal rule is a separator, to make it we have two options:
  1. Triple hyphens ---
  2. Triple underscores ___

---

Escape Characters

• In some cases we want to escape a character used by Markdown, in that case we use \ to show the actual special character.
• In example **this will not show in bold**

Block Quote

• To create a block quote we use the > symbol

This is a quote inside a block.

Links

• For links the text we wanna show goes into brackets [] while the URL address we want to point goes inside ()
• i.e. Google
  • To quickly turn a URL or email address into a link, enclose it in angle brackets
  • i.e. email@email.com or https://google.com
• To add a title when we hover the link we can just add "Title" after the URL address
• i.e. Google

Internal links (references)

• If you have headers in the markdown files, you can directly link them in the file.
• in example an ## The Header will automatically generate a #the-header anchor we can link
• in this case the link will be Go to header

Go to first section

Lists

Unordered lists

• ul can be displayed using * for each item

• item 1
  • item 1.1
• item 2
  • item 2.1
• item 3

Ordered lists

• ol can be shown using n. before each item

1. Hello
   1. World
2. My name
3. How are you?

Inline Code Block

• We use backticks
• import time

Images

• very similar to links but with a ! before the square brackets
• 

Github

• gh has its own flavor of markdown
• for block of codes use triple backticks instead of one ```
• we can also add specific syntax for the language we want to use

import React
const elem = () => {
    return(
        "This is something"
    )
}
export defaults elem

from datetime import datetime
dt = datetime(2020,10,1,12)
def getTime(dt):
    return dt.Hour

Tables

Tables	Are	Cool
col 1 is	left-aligned	$1600
col 2 is	centered	$12
col 3 is	right-aligned	$1

Task list

• These shows as checkbox on GH *[x] Task 1 *[x] Task 2 *[ ] Task 3

Academic Markdown ¹

Footnotes

Footnotes allow you to add notes and references without cluttering the body of the document. When you create a footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.

To create a footnote reference, add a caret and an identifier inside brackets (²). Identifiers can be numbers or words, but they can’t contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.

Add the footnote using another caret and number inside brackets with a colon and text (²: My footnote.). You don’t have to put footnotes at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.

Here's a simple footnote,² and here's a longer one.³

Footnotes

1. notes from Krycho ↩

2. This is the first footnote. ↩ ↩² ↩³

3. Here's one with multiple paragraphs and code. ↩