Markdown syntax help
for linebreak add 2 spaces at end, _italic_ or **bold**
End a line with two spaces to add a
How do I love thee?
Let me count the ways
Italics and Bold
*This is italicized*, and so is _this_.
**This is bold**, and so is __this__.
Use ***italics and bold together*** if you ___have to___.
Escape special char
You can escape special char
* _ # @ ! ` with
This is not strong \*strong\*.
underline by = and - or use #
Insert a horizontal rule
<hr/> by putting three or more hyphens, asterisks, or underscores on a line by themselves:
Using spaces between the characters also works:
- - - -
bullet with -, + or * and list with 1.
- Use a minus sign for a bullet
+ Or plus sign
* Or an asterisk
1. Numbered lists are easy
2. Markdown keeps track of the numbers for you
7. So this will be item 3.
Advanced lists: Nesting
To put other Markdown blocks in a list; just indent four spaces for each nesting level:
1. Bulleted lists in a numered list item:
* indented height spaces.
- Four spaces again.
2. Multiple paragraphs in a list items:
It's best to indent the paragraphs four spaces
You can get away with three, but it can get
confusing when you nest other things.
Stick to four.
You can do multiple paragraphs in a list.
This paragraph is still part of the list item, but it looks messy to humans. So it's a good idea to wrap your nested paragraphs manually.
3. Code block in a list item:
Skip a line and indent eight spaces.
That's four spaces for the list
and four to trigger the code block.
4. Blockquotes in a list item:
> indent the > by four spaces.
> to the beginning of any line to create a
> The syntax is based on the way email programs
> usually do quotations. You don't need to hard-wrap
> the paragraphs in your blockquotes, but it looks much nicer if you do. Depends how lazy you feel.
Advanced blockquotes: Nesting
To put other Markdown blocks in a
<blockquote>, just add a
> followed by a space:
> The > on the blank lines is optional.
> Include it or don't; Markdown doesn't care.
> But your plain text looks better to
> humans if you include the extra `>`
> between paragraphs.
Blockquotes within a blockquote:
> A standard blockquote is indented
> > A nested blockquote is indented more
> > > > You can nest to any depth.
Lists in a blockquote:
>- A list in a blockquote
>- With a > and space in front of it
> * A sublist
Code block in a blockquote:
> Indent five spaces total. The first
> one is part of the blockquote designator.
There are three ways to write links. Each is easier to read than the last:
Here's a direct link to [http://www.google.com/]().
Here's an inline link to [Google](http://www.google.com/).
Here's a reference-style link to [Google].
Here's a very readable link to [Yahoo!][yahoo].
Here's an implicite link to [Wikipedia].
The link definitions can appear anywhere in the document -- before or after the place where you use them. The link definition names
can be any unique string, and are case-insensitive;
[yahoo] is the same as
We have modified our Markdown parser to support "relative" links and wiki style.
Here's a direct link to [a page]().
Here's an inline link to [an another page](the link).
Here's a reference-style link to [an another page].
: the link
The link will be blue or red depending if the page exist in the group of the current page, but not in the preview.
You can also made a link to a page in another group.
The link must start like
/wiki/group/GUID/page/, where GUID is the id of the group. Take a look:
Here's a link to the home page of [the group](/wiki/group/42/page/home).
Here's a link to [a page of another group].
: /wiki/group/42/page/the page
Links can have a title attribute, which will show up on hover. Title attributes
can also be added; they are helpful if the link itself is not descriptive enough
to tell users where they're going.
Here's a [poorly-named link](http://www.google.com/ "Google").
[web]: http://elgg.org/ "Elgg"
You can also use standard HTML hyperlink syntax.
<a href="http://example.com" title="example">example</a>
Force URLs by enclosing them in angle brackets:
Have you seen <http://example.com>?
Images are exactly like links, but they have an exclamation point in front of them:
The word in square brackets is the alt text, which gets displayed if the browser can't show the image. Be sure to include meaningful alt text for screen-reading software.
Just like links, images work with reference syntax and titles:
This page is ![foo][foo].
You can use a slightly more verbose version of implicit reference names:
This ![foo] works.
The reference name is also used as the alt text.
You can also use standard HTML image syntax, which allows you to scale the width and height of the image.
<img src="http://foo.com/img.jpeg" width="100" height="100">
URLs can be relative or full.
indent by 4 spaces
Indent four spaces to create an escaped
printf("Hello world!"); /* his suicide note
was in C */
The text will be wrapped in tags, and displayed in a monospaced font. The first four spaces will be stripped off, but all other whitespace will be preserved.
Markdown and HTML is ignored within a code block:
You would hate this if it weren't
wrapped in a code block.
An other way is to wrap your code by three backticks. You can also specify the type of code in the block-code:
echo = 'Hello World!';
Use backticks to create an inline
Press the `<Tab>` key, then type a `$`.
(The backtick key is in the upper left corner of most keyboards.)
Like code blocks, code spans will be displayed in a monospaced font. Markdown and HTML will not work within them. Note that, unlike code blocks, code spans require you to manually escape any HTML within!
If you need to do something that Markdown can't handle, use HTML. Note that only a very strict subset of HTML are supported!
To reboot your computer, press <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>del</kbd>.
Markdown is smart enough not to mangle your span-level HTML:
<b>Markdown works *fine* in here.</b>
Block-level HTML elements have a few restrictions:
- They must be separated from surrounding text by blank lines.
- The begin and end tags of the outermost block element must not be indented.
- Markdown can't be used within HTML blocks.
<pre>You can <em>not</em> use Markdown in here.</pre>