Markdown guideline

Creating pretty markdown


Summary

__

Comments

To comment a markdown file just use

<!--  Comment here  -->
<!--- Comment here --->

Styling text

Bold

** Text ** or __ Text __

Text or Text

Italic

* Text * or _ Text _

Text or Text

Bold and Italic

Just combine __ or ** (Bold) with _ or * (Italic)

__Is this _important_ yes or no?__

**Is this _important_ yes or _no?_**

__Is this *important* yes or _no?___

Is this important yes or no?

Is this important yes or no?

Is this important yes or no?

Strikethrough

To strikethrough a text
~~ Wrong Text ~~

Wrong Text

Headings

Creating Heading sections

Big to small
#      | Header 1
##     | Header 2
###    | Header 3
####   | Header 4
#####  | Header 5
###### | Header 6

Title (1 #)

Title (2 #)

Title (3 #)

Title (4 #)

Title (5 #)
Title (6 #)

Lists

Unordered lists

Add - or *
- Apple
- Banana
- Orange
  • Apple
  • Banana
  • Orange

Ordered Lists

Just add a number
1. Apple
1. Banana
1. Orange
  1. Apple
  2. Banana
  3. Orange

Nested Lists

It is easy
1. First
   - Second
     - Third

Just note the identation and marker character
1. First
___- Marker Character (-) Below the first character of the text
_____- Same as above, note '-' is just below the M
  1. First
    • Second
      • Third

Task Lists

Create a pretty task list is easy

Just use - [ ] (with a space between the brackets)
Done tasks? Just add a 'x' between  brackets ([x])
- [x] Item 1
- [ ] Item 2
- [ ] Item 3
  • Item 1
  • Item 2
  • Item 3

Quotes

To quote a phrase just use '>'
No quote
> With quote

No quote

With quote