documon/more/200.Comment Authoring Guide/250.Markdown Cheatsheet.md

A documentation system for mortals. Use with any language.

# Markdown Cheatsheet

Other nice visual references:

- [https://markdown-it.github.io/](https://markdown-it.github.io/)
- [https://en.support.wordpress.com/markdown-quick-reference/](https://en.support.wordpress.com/markdown-quick-reference/)

## Headings

	# h1 Heading
	## h2 Heading
	### h3 Heading
	#### h4 Heading
	##### h5 Heading
	###### h6 Heading

## Horizontial Rule

(3 or more dash or underscore characters)

	---	 or ___
	


## Italic

	*my words*   or   _my words_

## Bold

	**my words**   or   __my words__


## Links

Inline:

	[display text](http://example.com "Shows when hover")
	
Referenced:
	
	For more [click me][1] and another [or me][2].

	-- then somewhere else (like at the bottom of the page) ---
	
	[1]: http://example.com/ "Shows when hover 1"
	[2]: http://example.org/ "Shows when hover 2"


## Images
 
Bare bones:
	
	![](assets/example.jpg)
	
All the bells and whistles

	!["alt" text here](assets/example.jpg "Hover over image text")

Referenced

	![][1]
	
	-- then somewhere else (like at the bottom of the page) ---
	
	[1]: url/to/image.jpg "Shows when hover 1"
	

Linked image (simple)

	Click this image [![](/example.jpg)](http://example.com/)

Linked image (bells and whistles)

	Click this image [![alt text](/example.jpg)](http://example.com/ "Hover text here")
	


## Blockquotes

	> Add a ">" symbol in front of paragraph. 
	> Connected ">" symbols (vertically) 
	> get lumped together as one.

__Code within blockquotes__
Use a tab or spaces like usual, just pretend the > is the edge. __IMPORTANT:__ Multi-line code requires one additional blockquote > after the code all by itself at the bottom.

	 > 	function(){
	 >		var foo
	 >		var bar
	 >	}
	 > <------------------- need this guy here

## Footnotes

	I have more [^1] to say up here.
	
	-- then somewhere else (like at the bottom of the page) ---
	
	[^1]: To say down here.

## Lists

Unordered

	* item 1
	* item 2
	* item3
	
	-- or -- 
	
	- item 1
	- item 2
		* mixed
		* is
		* fine
		* too
	- item 3

Ordered

	1. item 1
	2. item 2
	3. item3
	
	-- or (just as long as number-dot exists)--

	1. item 1
	1. item 2
	1. item 3


## Preformatted

		Begin line with 2 or more spaces or a tab.


## Code 

Inline

	`This is code`
	

Block

	```
	This is too
	```


Syntax Highlighted

	```css
	#button {
	    border: none;
	}
	```


## Definition List

	Javascipt
	:  A relatively easy language to learn

	Markdown
	:  Text-to-HTML conversion tool



## Abreviations

	For example HTML stands for (hover over HTML)
	
	-- then somewhere else (like at the bottom of the page) ---
	
	*[HTML]: HyperText Markup Language