Mastering Markdown

Based on Wes Bos' Mastering Markdown course.

Text decoration

This is a basic paragraph.

italic

bold

strong emphasis

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

This heading has a custom id {#custom-heading}

Links

http://theodinproject.com

Link to the Odin Project

A tagged link

A different tagged link

This is a link to the custom heading but I'm not sure if it is working and I don't presently know how to check. Perhaps you need enough content to have the tagged heading exist off-screen before the link will snap to the heading.

Images

Basic image format:

Tagged image link:

Image with an external link:

Lists and Nesting

Unordered Lists

milk
eggs
bread

Ordered Lists

You don't need to number the list, just use the number "1." to mark an item in an ordered list.

Item A
Item B
Item C

Sub Items

Step One
- This is a sub bullet
- This is also a sub bullet
  - And so is this. The style is not controlled by the syntax.
Step Two
1. This is a sub ordered item
2. This is another
Step Three

Here is a nested paragraph. You can also nest images.

Line Breaks

Just use an HTML
tag to create a line break.

Horizontal Rules

Here is a horizontal rule:

Block Quotes

This is a block quote.

With two paragraphs.

Code Blocks

Markdown accepts HTML and CSS (when placed in an HTML <style></style> tag.)

You can fence your code with triple tilde.

You can also define the language you are using:

<body>
    <h1>Hello World.</h1>
</body>

let x = true;
const dog = `Great Dane`;

You can also show diff in code...

var x = 100;
- var y = 200;
+ var y = 300;

Tables

Tables are created by piping cells and positioning headings and data above or below defined column syntax, respectively.

Heading 1	Heading 2	Heading 3
Item 1	Item 2	Item 3
Item A	Item B	Item C

You can define the alignment of elements with colons:

Right Aligned

Heading 1	Heading 2
Item 1	Item 2

Left Aligned

Heading 1	Heading 2
Item 1	Item 2

Centered

Heading 1	Heading 2
Item 1	Item 2

Mixed

Heading 1	Heading 2
Item 1	Item 2

GitHub Syntax

Check boxes

Milk
Eggs
Bacon

Issue and user linking

Adding an issue number like #1 and @alexrmann tags will provide GitHub specific links that are not part of the standard Markdown syntax.

alexrmann / markdown-tutorial Goto Github PK

markdown-tutorial's Introduction