Posts Markdown Notes
Post
Cancel

Markdown Notes

These markdown notes are referenced from Markdown Basics, Github Guides and Writing on Github.

Click here for this markdown source file

HEADERS

There are two styles of headers: Setext and atx.

Setext (Use = or -)

A First Level Header

A Second Level Header

atx (Use 1-6 hash marks(#) at the beginning of the line)

Header 3

Header 5

BLOCKQUOTE

This is a blockquote.

This is the second paragraph in the blockquote.

This is an H2 in a blockquote.

PHRASE EMPHASIS

Markdown uses asterisks and underscores to indicate spans of emphasis.

  • Some of these words are italic.

  • Some of these words are italic also.

  • Use two asterisks for bold.

  • Or, if you prefer, use two underscores instead.

LISTS

Unordered lists use asterisks, pluses, and hyphens(**, +, -) as list markers. They are interchangeable.

  • Apple
  • Orange
  • Grape

  • Banana
  • Mango
  • Watermelon

  • Pineapple
  • Strawberry
  • Cherry

Ordered lists use regular numbers folllowed by periods as list marker.

  1. Baby
  2. Teenager
  3. Adult
  4. Oldman

To input multiple lines in one single item: insert blank lines between lines and use 1 tab for each line.

  • A list item

    with multiple lines.

    another line

  • Another list item.
  • The third item.

LINKS

There are two styles for creating links: inline and reference.

Inline style:

Reference style:

Or, we can use name as index.

IMAGES

Image syntax is very much like link syntax.

When the image source is a link: Image of Yaktocat

When the image source is one folder: Image of bulb

Align two pictures in one row: (use pipe) | A little every day

CODE

The following are code blocks.

Either simply indent a tab.

1
2
def __init(self):
	self.height = 160

Either use backticks.

1
2
def __init__(self):
    self.height = 160

Either use Syntax highlighting (GFM).

1
2
def __init__(self):
	self.width = 20

TASK LISTS (GFM)

  • this is an incomplete iterm
  • this is a complete item

TABLES (GFM)

First HeaderSecond Header
Content from cell 1Content from cell 2
First columnSecond column

Tips for Markdown

  1. Use Markdown TOC extension in VSCode to insert table of contents automatically.
This post is licensed under CC BY 4.0 by the author.