Dano Manion

Markdown Notes

  • Is an attempt to future proof documents by using a plain text syntax that can be used to creat HTML, PDF, and other types of documents.
  • It can be used to create documents quickly.
  • For anything, book writting, blog writting.
  • Whitespace is your friend

Paragraph

Going to catch the red dot today going to catch the red dot today. Hack up furballs purrrrrr. Throwup on your pillow damn that dog caticus cuteicus so hide when guests come over, and missing until dinner time, and stare at the wall, play with food and get confused by dust.

With tail in the air eat the fat cats food so eat owner’s food. Always hungry loves cheeseburgers and meowzer! mrow wake up human for food at 4am, or lick yarn hanging out of own butt.

Headlines

  • 2 ways to do this, with 3 “===” or “—”

Less common approach

  First Level headline
  ====================


  Second Level Headline
  ---------------------

More common Approach

    # First Level headline
    ## Second Level headline
    ### Third Level headline
    #### Fourth Level headline
    ##### Fifth Level headline

Can do this too

  # First Level headline #
  ## Second Level headline ##
  ### Third Level headline ###
  #### Fourth Level headline ####
  ##### Fifth Level headline #####

Bold and Italics

Going to catch the red dot today going to catch the red dot today. Hack up furballs purrrrrr. Throwup on your pillow damn that dog caticus cuteicus so hide when guests come over, and missing until dinner time, and stare at the wall, play with food and get confused by dust.

Bullets

Hyphens are the most widely accepted way to do lists.

  • Several ways to do these
  • Use 4 spaces or 1-tab as a standard for indention

With “*”

  • first list item
  • second list item
    • sub list item
    • sub list item
  • third list item

With “+”

  • first list item
  • second list item
    • sub list item
    • sub list item
  • third list item

With “* & +”

  • first list item
  • second list item
    • sub list item
    • sub list item
  • third list item

With “-“

  • first list item
  • second list item
    • sub list item
    • sub list item
  • third list item

With “1. 2. 3. 4. ect”

  1. first list item
  2. second list item
    1. sub list item
    2. sub list item
  3. third list item

Definition List

  • Depends on styling of output
This is my term
define it below with a colon and a space

Linking

  • There are several ways to do this.
  • There are no ways to add attributes to links

Inline Linking

Google.com

Reference Format

This can be done to help declutter the flow of reading the document in plain text.

Check out my link text here.

Self-Linked URL

http://google.com

headline [middle] (depends on flavor of Markdown)

Give me a link to the top of the document. Give me a link to the middle of the document

Images

Emma loves Easter

Blockquotes

Cats love to purr.

  1. List item
  2. Another list item
    1. Another-another list item

    Blockqoute inside of a list needs atleast one space to keep it’s presentation.

Clode Blocks / Verbatim

Code block. Just indent!

def hello
	puts "hellow world"
end

Use a fence with back-ticks

def hello
	puts "hellow world"
end

Hardline Breaks

Use two spaces to perserve line breaks ` `

Going to catch the red dot today going to catch the red dot today. Hack up furballs purrrrrr. Throwup on your pillow
damn that dog caticus cuteicus so hide
when guests come over, and missing until dinner time,
and stare at the wall,
play with food and get confused by dust.

Checkboxes

Github will render these.

  • [ ] Todo Task 1
  • [ ] Todo Task 2
  • [ ] Todo Task 3

Extensions

Footnotes

Consistant accross most processors.

Going to catch the red dot today going to catch the red dot today. Hack up furballs purrrrrr1. Throwup on your pillow damn that dog caticus cuteicus so hide when guests come over, and missing until dinner time, and stare at the wall, play with food and get confused by dust.2

Tables

Most processors support tables.
There are plugins that will cleanup tables for you as well.

header cell 1 header cell 2
cell 1 cell 2
cell 3 cell four yo!
Header cell 1 Header cell 2
cell 1 cell 2
cell 3 cell four yo!

Multi Markdown Meta Data

Only works in Multi-Markdown
Like yaml

Top of Document —

Title: Markdown Notes Date: 2016-12-23 Base Header Level: 2

[%title]


Discount

Centering text.

->Center this text<-

Kramdown

Provides several features most useful to webdevelopers like ability to add classes.

Align sentence to the left.

Github Flavored Markdown

Features of Github

  • All linebreaks are retained.
  • Can use language specific code highlighting
Example
console.log(hello);

Mathjax

Mathjax is a way to render out mathematical equations beautifully in markdown.

Smartypants

Will make qoutes correct.

Use Markdown in the Real World

  1. Leanpub
  2. Jekyll, Pelican, WordPress, Ghost (CMSs)
  3. Draft, for collaboration
  1. This is the footnote. 

  2. This is the footnote.