Markdown is a simple markup language used for text formatting. A brief overview can be found by clicking the "?" link at the top of any markdown editor. A more thorough description of markdown can be found on Daring Fireball
. The version of markdown that we support has a couple modifications from the standard markdown syntax. These modifications are:
Fenced code blocks
In addition to designating a code block by four spaces, a code block can also be created by enclosing the code within three ticks. This is demonstrated in the following markdown:
When this markdown is rendered, it will look as follows:
The tick key, `, is different from the apostrophe key. The tick is found on the same key as the tilde just to the left of the "1" key on many keyboards.
To enable syntax highlighting for a codeblock, type the language you are using after the ``` as seen below:
The languages we support and the acceptable variations of their names are seen below. Please note that the names are case insensitive.
| Language || Name Variations |
| TypeScript || TypeScript, TS |
| F# || F#, FSharp, FS |
| XML || XML |
| Java || Java |
| SQL || SQL |
| C# || C#, CS, CSharp |
| VB.NET || VB.NET, VBNet, VB, VisualBasic, Visual Basic |
| ASPX (C#) || ASPX(C#), ASPX-CS, ASPX |
| ASPX (VB.NET) || ASPX(VB.NET), ASPX-VB |
| C++ || C++, CPP |
| PHP || PHP, PHP3, PHP4, PHP5 |
| PowerShell || PowerShell, POSH, PS1 |
| Markdown || Markdown, MD |
| Haskell || Haskell, HS |
| Koka || Koka, KK, KKI |
Any text that follows standard URL format will be rendered as a link. Instead of using the markdown format, [title](URL), to create a link, you can simple enter the URL.
Auto new lines
A line break can be created by simply hitting return. This is a deviation from standard markdown which requires two spaces and a return to create a line break.
A word that has multiple underscores (foobar
baz) will not be rendered as alternating italicized words. Instead, it will be rendered as a word with multiple underscores in it.