Markdown Reference
A quick and greatly truncated reference guide for Markdown.
See Also:
- CommonMark Specification
- goldmark markdown parser used by Hugo.
Linking
Formating
This is a paragraph with **bolded** text. This is another paragraph with *emphasized* text. This is `inline code` in this paragraph.
This is a paragraph with bolded text.
This is another paragraph with emphasized text.
This is inline code in this paragraph.
Block Quotes
A block quote example: > **This is a block quote.** Lorem ipsum dolor sit amet, consectetur > adipiscing elit. Cras mattis consectetur purus sit amet fermentum. > > > **With a sub-block quote.** Lorem ipsum dolor sit amet, consectetur > > adipiscing elit. Cras mattis consectetur purus sit amet fermentum. > > — mgemmill Some post block information.
A block quote example:
This is a block quote. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras mattis consectetur purus sit amet fermentum.
With a sub-block quote. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras mattis consectetur purus sit amet fermentum.
— mgemmill
Some post block information.
Headers
# Header h1 ## Header h2 ### Header h3 #### Header h4 ##### Header h5 ###### Header h6
Header h1
Header h2
Header h3
Header h4
Header h5
Header h6
Code
A code block:
def python_code_sample():
print "Uses hightlight.js to get the syntax right."
A code block:
def python_code_sample():
print "Uses hightlight.js to get the syntax right."
Lists
Use `*`, `-` or `+` to make a standard unordered html list: * apple * orange * banana Use numbers to make an ordered html list: 1. Wendy 2. Jane 3. Isabel
Use *, - or + to make a standard unordered html list:
- apple
- orange
- banana
Use numbers to make an ordered html list:
- Wendy
- Jane
- Isabel
Miscellaneous
Use 3 or more * or - or _ characters in a row - on a line
by themselves - to create a rule. They can have spaces between
them.
rules made with `*`: *** * * * * * * * * * rules made with `-`: --- - - - - - - - - - rules made with `_`: ___ _ _ _ _ _ _ _ _ _
rules made with *:
rules made with -:
rules made with _: