Skip to content

Instantly share code, notes, and snippets.

@icheft
Last active May 19, 2020 07:20
Show Gist options
  • Save icheft/367f10b4868073ad15b9eb358a3ea37e to your computer and use it in GitHub Desktop.
Save icheft/367f10b4868073ad15b9eb358a3ea37e to your computer and use it in GitHub Desktop.
A simple introduction to markdown and a basic cheatsheet for everyone

Markdown for Everyone

By Brian L. Chen

What is Markdown?

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on many apps, platforms, and websites.

How to Use Markdown?

You only have to remember some basic syntax!

Headings

As you might be able to tell, "Headings" can be done by typing a # in the front.

There are six levels of headings.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

####### There is no Heading 7 since Heading 6 is already the same size as the text.

Paragraphs

Don't put tabs or spaces in front of your paragraphs.

Keep lines left-aligned like this.

To create a line break, end a line with two or more spaces,
and then type return.

Emphasis

Bold

Adding a bold text.

Italic

Adding an italic text.

Lists

Unordered Lists

  • aka. UL
  • just place a + in front of each item
  • item 1
  • item 2
    • item 3 (nested)

Ordered Lists

  1. You don't have to care about the order you type
  2. πŸ‘ˆ as you can see here, I type 1 instead of 2.
  3. πŸ‘‰ but here the number has already been updated to 3.
  4. Of course you can type out the correct order:
    1. first item
    2. second item
    3. third item
      1. more items

Links

To create a link, you wrap the link text in brackets [], and then you wrap the link in parentheses ().

Link to Google. And link to my website

Images

Add an extra exclamation mark ! in front of the link.

awesome image

Combining the two of them, you get to see my website by clicking the gif below: awesome gif

Others

Due to time limits, I will only cover the basics of markdown. This section is left for more advanced usage of markdown.

Blockquotes

Use blockquotes to draw attention or quote others' words.

My favorite quote from Steve Jobs:

People who are crazy enough to think that they can change the world are the ones who actually do.

Tables

Tables Are Cool
col 1 is col 2 is col 3 is
left-aligned centered right-aligned
default 🌡 πŸ‘‰

Horizontal Rules


Math Equations

The most beautiful equation in math: beautiful equation

A matrix:

matrix

Footnotes

Footnotes

Footnotes are notes placed at the bottom of a page.1 Here's a long footnote.2

Codes

To indicate an inline code use tick. print("Hello, World!")

Or you can have a whole section of code block, too.

def hello():
    print("Hello, World!")

hello()

More Emphasis

Highlight

Highlight? ==No problem!==

Strikethrough

Strikethrough? No problem!

Task Lists

Agenda:

  • What is Markdown?
  • How to Use Markdown?
    • Live Coding
  • Real-life example!
  • Takeaways

Let's me add some links to more resources and some more contents to make a complete cheatsheet for you!

A Real-Life Example! I am going to deploy this content to my hackmd πŸ§‘πŸΎβ€πŸ’».

Where can You Use Markdown?

  • Taking notes
  • Writing homework
  • Addressing technical documentations
  • Creating website contents
  • Composing Emails
  • Creating slides

Resources


1. Reference: What Are Footnotes?. ↩

2. A long footnote with multiple paragraphs:
Indent paragraphs to include more.
Add more like this! ↩

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