Goal for this document
I wanted to make a page that contained most if not all of the different things that you would find in a blog post written in Markdown. For simplicity, I’ll stick to what is found in Python-Markdown as it is the one that I use most.
Basic Syntax
This sentence as emphasied and bold text.
This sentence has emphasis and bold text combined.
This sentence has code
written in it.
This sentence has strikethrough written in it.
This is a sentence with a link.
Multiple Paragraphs of text
Pack my box with five dozen liquor jugs. Several fabulous dixieland jazz groups played with quick tempo. Back in my quaint garden, jaunty zinnias vie with flaunting phlox1. Five or six big jet planes zoomed quickly by the new tower. Exploring the zoo, we saw every kangaroo jump and quite a few carried babies. I quickly explained that many big jobs involve few hazards. Jay Wolf is quite an expert on the bass violin, guitar, dulcimer, ukulele and zither. Expect skilled signwriters to use many jazzy, quaint old alphabets effectively. The wizard quickly jinxed the gnomes before they vaporized. THE QUICK BROWN FOX JUMPED OVER THE LAZY DOG’S BACK 12345678902.
Lorem ipsum dolor sit amet, eu detracto senserit vis, ei natum
ridens detracto sit. Id iriure prompta vix. Sit ea feugiat invenire similique, etiam solet eleifend cu per. Ea falli nullam elaboraret vis, modo percipitur omittantur at ius, in quo nullam timeam ocurreret. Est ad deleniti corrumpit scripserit, te usu apeirian recusabo oportere, nemore laboramus vulputate te vim. Ea eum mazim iudicabit, harum utroque
pri ne.
Per no putant iriure intellegebat. Tamquam maiorum ei eum, ea iuvaret maluisset liberavisse eam, adhuc falli tamquam ius te? Eu amet virtute scaevola est, simul nusquam invidunt duo id, at usu sanctus abhorreant definiebas! Vide ullum quo cu? Ius in forensibus sadipscing, dicant aperiri volutpat et sit.
Veri dicat pro te, an aliquam reprimique cum, et pro commune maiestatis. Nec ex amet eleifend definitiones! An adipisci consequuntur
est. In quot oratio vis. Vide nobis aperiam pri ad, et sit dictas adolescens inciderint, pertinacia referrentur consequuntur pri id?
Images
Large image
Images in a paragraph
Yar Pirate Ipsum. Rutters log red ensign bring a spring upon her cable Pirate Round prow fathom. Snow broadside Arr poop deck hardtack lad barkadeer. Cat o’nine tails handsomely fire ship reef bring a spring upon her cable yardarm jury mast. Hang the jib mutiny execution dock cutlass Sail ho furl ye. Barque crimp aye fore nipper yo-ho-ho grog. Crack Jennys tea cup Brethren of the Coast weigh anchor spanker port rutters jack.
Man-of-war tender lanyard piracy yard prow case shot. Bilge brig six pounders loot landlubber or just lubber me salmagundi. Chantey keelhaul Pieces of Eight hail-shot mutiny brigantine barque. Dead men tell no tales American Main parrel code of conduct haul wind hornswaggle Admiral of the Black. Cable no prey, no pay bilge rat swab wherry boom run a shot across the bow. Run a shot across the bow skysail strike colors Sail ho lateen sail wench Barbary Coast.
List
There are two kinds of lists with
Ordered lists
-
First item
-
Second item
Second paragraph of Second item
-
Third item
A small paragraph before the second list.
-
Forth item - If this doesn’t start with 4 than smart list are not on.
-
Nested unordered list item 1
-
Nested unordered list item 2
-
Nested unordered list item 3
-
-
Fifth item
-
Six item
Unordered lists
-
First item.
-
Second item. This second item has two paragraphs in it.
This is the second paragraph of the second item. (Not confusing at all.)
Block quote in the unordered list
Followed by a code block:
{ "firstName": "John", "lastName": "Smith", "age": 25 }
-
Third item.
-
Nested ordered list item 1
-
Nested ordered list item 2
-
Nested ordered list item 3
-
-
Forth item.
Footnotes
I am going to use the example from the footnote documentation3.
Block quote
Something simple should go here.
Remember, you have within you the strength, the patience, and the passion to reach for the stars to change the world.
- Harriet Tubman
Sometimes you might have nested block quotes.
You miss 100% of the shots you don’t take.
- Wayne Gretzky
- Michael Scott
Tables
This is my tables section. These were taken from https://markdown-it.github.io/ and https://michelf.ca/projects/php-markdown/extra/#table.
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Right aligned columns
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Centered values
Item | Value |
---|---|
Computer | $1600 |
Phone | $12 |
Pipe | $1 |
Function name | Description |
---|---|
help() |
Display the help window. |
destroy() |
Destroy your computer! |
Misc
These are the things that most people don’t really use.
Definitions
Definitions are a great way to show information.
- Apple
- Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
- An American computer company.
- Banana
- A tropical plant of the genus Musa.
- Orange
- The fruit of an evergreen tree of the genus Citrus.
- Pinapple
- A tropical fruit from the Bromeliaceae family.
- Mango
- A juicy stone fruit (drupe) from numerous species of tropical trees belonging to the flowering plant genus Mangifera, cultivated mostly for their edible fruit.
Complex definitions
- Term 1
-
This is a definition with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
-
Second definition for term 1, also wrapped in a paragraph because of the blank line preceding it.
- Term 2
-
This definition has a code block, a blockquote and a list.
code block.
block quote on two lines.
- first list item
- second list item
Code blocks
import logging
# This line is emphasized
# This line isn't
# This line is emphasized
def func():
# function body
someValue = "func called"
logging.info(someValue)
if __name__ == '__main__':
func()
Abbreviations
The HTML specification is maintained by the W3C. This example taken from https://python-markdown.github.io/extensions/abbreviations/
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
Task Lists
This is fairly new to markdown.
- Write the press release
- Update the website
- Contact the media
- foo
- bar
- baz
- bim
-
A footnote in the middle of a larger paragraph has a footnote somewhere else. ↩︎
-
These were all alternatives to the famous pangram for testing fonts found here. ↩︎
-
The first paragraph of the footnote.
The second paragraph of the footnote.
A blockquote with multiple lines. (This should be on second line)
a code block
A final paragraph in the same foot note. ↩︎