Skip to content

Instantly share code, notes, and snippets.

@nikography
Created August 15, 2011 11:20
Show Gist options
  • Star 6 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save nikography/1146055 to your computer and use it in GitHub Desktop.
Save nikography/1146055 to your computer and use it in GitHub Desktop.
markdown compilation

markdown reference

footnotes:

works in tumblr with markdown editor enabled
requires multimarkdown

input:
sentence with footnote[^1].
[^1]: this is the footnote, note colon + space.

output:
Sentence with footnote1.

line breaks

end a line with two spaces and return.

showing code

code can shown inline with `backticks` or

		indented one level within text
			you may indent further

to show a backtick within inline code,
enclose it within a pair or triplet of backticks.


info and reference

markdown syntax: documentation
daringfireball.net/projects/markdown/syntax

multimarkdown syntax guide: extends stuff, includes footnotes functionality
github.com/fletcher/MultiMarkdown/...

introductory article: lots of links
messagingnews.com/onmessage/ben-gross/markdown-simplifies-writing-web

daring fireball: markdown's home
daringfireball.net/projects/markdown


tools

markdownify: html to markdown converter
milianw.de/projects/markdownify

markdown css: stylesheet for additional prettiness
kevinburke.bitbucket.org/markdowncss

web editor/dingus: there are a few of these
php markdown dingus // markdown dingus


applications/plugins for mac os

markdown quicklook plugin:
plugin to quicklook/preview markdown files
github.com/toland/qlmarkdown

how to install quicklook plugin:
copy into ~/Library/Quicklook or /Library/Quicklook

marked: live preview for text editors2
markedapp.com

byword: markdown/text editor
bywordapp.com

readown: markdown viewer
code.google.com/p/readown

elements: dropbox/markdown text editor for iOS
secondgearsoftware.com/elements/


cheatsheet

# h1
## h2
### h3 you may 'close' hashes ###
#### h4 (thru h6)

this is also an h1
======

this is also an h2
------

> blockquote style one la la la  
i am still part of this blockquote

> another style of marking up  
> blockquotes. this is email style  
> quoting. blockquotes can be nested.

these are all unordered lists:

	* proto		- proto		+ proto
	* exo		- exo		+ exo
	* auxo		- auxo		+ auxo

these are all ordered lists:

	1. proto	1. proto	1. proto
	2. exo		4. exo		+ exo
	3. auxo		3. auxo		+ auxo

horizontal rules: (three or more)

	* * *

	***

	*****

	- - -

	------------------------

a link:

	[link text](http://yoursite.com/ "title")

	[link text no title](http://anothersite.com/)

	<address@example.com> will obfuscate your link a bit

an image:

	![Alt text](/path/to/img.jpg "optional title")

	![Alt text](/path/to/img.jpg)

emphasis:

	*hello* or _hello_ produces italicized [em] text

	**hello** or __hello__ produces bold [strong] text

	\*how to surround text with actual asterisks\*


markdown provides backslash escapes for the following characters:

	\   backslash
	`   backtick
	*   asterisk
	_   underscore
	{}  curly braces
	[]  square brackets
	()  parentheses
	#   hash mark
	+   plus sign
	-   minus sign (hyphen)
	.   dot !   exclamation mark

Footnotes

  1. This is the footnote, note colon + space.

  2. holy crap this rules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment