Markdown Cheat Sheet

__NOTOC__
Markdown is a way of formatting text and inserting images. It can be used with the following features of Habitica:
* Titles, notes, and checklists for tasks and Rewards (including tasks and Rewards for Challenges and Group Plans)
* Titles, summaries, and descriptions of Parties and Challenges
* Posts in Parties and Group Plans
* Private Messages
* Profile text
The images inserted with Markdown can be hosted on any web site. (Emoji can also be used to insert small images without using Markdown, but the selection of images is limited.)
Note that in the mobile apps, the formatting produced by Markdown (as shown in the table below) may not display as expected.
Do not use Glitch text in Habitica. It does not display properly in many cases, and does not work with translation software or screenreaders.
For ideas on how to use Markdown to further enhance your Habitica experience, see Markdown Use Case Spotlights.
== Markdown Examples ==
===Links, Images and Emoji===
You see 	You enter	Notes
Habitica	[Hypertext link](URLofYourWebsiteHere)
For example:[Habitica](https://habitica.com)	Note that there is no space between the square and rounded brackets.
 	![alt text describing the image](URLofYourImageHere "optional mouseover title")
For example:![green speckled potion in a flask with a brown stopper](https://example.com/example_image_name.png "Zombie hatching potion")	Alt text specifies the alternative text shown in place of an image if it cannot be displayed because of a slow connection, an error in the URL, or if someone uses a screen reader. The alt text must be present. Enter the full URL of your image (which will be resized).
 	:smiley: 	This emoji cheat sheet or this emoji collection has hundreds of emojis, but if the code doesn't work, you can use your operating system's character viewer (MacOS, Windows, Linux) to insert one.
===Other Markdown===
As shown in the table below, headers of different levels can be created by preceding the text with one or more # (hash marks). Markdown specifies six header levels (H1-H6); the smallest header uses six hash marks. The hash marks must be at the start of a line and there must be a space between them and the text of the header; otherwise, the hash marks will remain visible and the text will not be enlarged. In chat, use headers only when essential because they take up a lot of space.
You see 	You enter 	Notes
Header 1 	# Header 1 	See the notes above about headers.
Header 2 	## Header 2 	
Header 3 	### Header 3 	
Italicized text 	*Italicized text*
_Italicized text_ 	_ can be used in place of *
Bold text 	**Bold text** 	
Strikethrough text 	~~Strikethrough text~~ 	
Italic & bold text 	***Italic & bold text*** 	
_Not Italicized_# Not a Header
**Not Bold** 	
\_Not Italicized\_
\# Not a Header
\*\*Not Bold\*\* 	If you wish to type a symbol used in Markdown as is, place a backslash before each symbol.
 	`code` 	For international users that don't have the ` (backtick) character on the keyboard, you can insert it by typing "96" while pressing ALT.
 	>Quoted text 	Multiple ">" characters can be used for quoted quotes
 	After "This is standard text", Enter or Shift-Enter twice to start a new paragraph. Insert four spaces before "This is a highlighted paragraph." 	Use this to highlight a paragraph.
 	On a new line, enter three backticks (```). On subsequent lines, enter the text or code. End the code block with another line of three backticks (```).
Long paragraphs will not wrap automatically. To obtain wrapped lines as shown in the image to the left, insert line breaks manually.
Enter or Shift-Enter creates a line break.
Enter or Shift-Enter twice adds a blank line.
Unlike the previous highlighted text method, this does not require four spaces at the start of every paragraph.	Markdown code blocks display as unformatted text and are typically used for displaying software code.
For international users that don't have the ` (backtick) character on the keyboard, you can insert it by typing "96" while pressing ALT.
One line of textAnother one under it 	Type two spaces after the first line and press Enter or Shift-Enter once to produce this. 	Type text, type two spaces, go to next line, type text.
One line of textAnother one under it with padding separating the two 	Enter or Shift-Enter twice in a chat window to produce this. Before submitting, your text should look like this:One line of textAnother one under it with padding separating the two 	Type text, make a blank line, type text.
    Manually     Pad     Text	&ensp; in front of words to be able to have multiple spaces between words. 	This is good for centering or tabbing task headings.
• Unordered (Bulleted) Lists 	On a new line type + or * or - followed by a space. 	For international users that don't have the + (plus) character on the keyboard, you can insert it by typing "43" while pressing ALT.
1. Ordered (Numbered) Lists 	On a new line type 1. followed by a space. 	
Horizontal Line 	Enter or Shift-Enter twice, ---, and Enter or Shift-Enter twice again in a chat window to produce this. Alternatively, Enter or Shift-Enter once, three underscores (___), and Enter or Shift-Enter again.	Type text, make a blank line, type three dashes, make a blank line, type text. -OR- Type text, go to next line, type three underscores, go to next line, type text.
Table Of Text
First Header Second Header
Content Cell  Content Cell
Content Cell  Content Cell	
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell 	Great for auto aligning text with header.
Only three hyphens are required (---); using more than three will still render correctly, however.
–— 	&ndash;&mdash; 	HTML entities are supported in Markdown. To use them, simply type or insert the piece of text ("string"). The string begins with an ampersand (&) and ends with a semicolon (;).
== Markdown Workarounds ==
Markdown can be extremely helpful but at times the built-in shortcuts can cause problems. The following table contains known issues and suggests solutions.
You see	You wanted	Solution	Notes
1. Item One
1. Item Two
1. Item Three	1. Item One
2. Item Two
3. Item Three	1\. Item One
2\. Item Two
3\. Item Three	Markdown interprets a line beginning with a numeral followed by a period as a numbered list item. If Markdown resets numbering when it is not supposed to, inserting a backslash between the number and the period solves the problem.
== Markdown Tricks ==
The following table includes some tricks that are usable wherever Markdown can be interpreted.
You see 	You enter 	Notes
 	![progress](https://progress-bar.xyz/28/ "progress")	Progress bars can be incorporated in Habitica to display the relative progress for each Habit, Daily, Task (or even each checklist item), or Reward as well as the rest of Habitica where Markdown is supported.
See the project page on GitHub for more examples.
Mathematical formulas and graphics (LaTeX)	![alt text](URLofYourImageHere "optional mouseover title")
Replace 'URLofYourImageHere' with an image link generated as follows:
#Input your math string in QuickLaTeX (TikZ is also supported) and select any preferred options. If you are not familiar with the LaTeX syntax, try an online visual editor such as HostMath to create a string you can copy into QuickLaTex's input box.
#Click on the Render button. The site generates an image that is cached on the server, and provides a link to the image.	This uses the regular Markdown image syntax to insert mathematical formulas and graphics.
Alt text specifies the alternative text shown in place of an image if it cannot be displayed because of a slow connection, an error in the URL, or if someone uses a screen reader. The alt text must be present. Enter the full URL of your image (which will be resized).
==See also==
*The Official Markdown Syntax Guide (not part of the Wiki; goes to the inventor's (John Gruber's) official site)
*What is Markdown?
fr:Mémo de Markdown
ru:Шпаргалка по Markdown
ja:マークダウン便利表
zh:Markdown格式帮助
pt-br:Markdown Cheat Sheet
Category:Social
Category:Quick References
Category:Pages with files missing alt tags