Markdown help

Basic Links

The link definitions can appear anywhere in the document -- before or after the place where you use them. The link definition names [1] and [yahoo] can be any unique string, and are case-insensitive; [yahoo] is the same as [YAHOO].

Advanced Links

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 <span class="bg-black-300">[poorly-named link](https://www.google.com/ "Google")</span>.
Never write "[click here][^2]".
Visit [us][web].
  [^2]: https://www.w3.org/QA/Tips/noClickHere
        (Advice against the phrase "click here")
  [web]: https://ebooks.stackexchange.com/ "Ebooks Stack Exchange"

You can also use standard HTML hyperlink syntax.

<a href="https://example.com" title="example">example</a>

The number of = or - signs doesn't matter; one will work. But using enough to underline the text makes your titles look better in plain text.

Use hash marks for several levels of headers:

# Header 1 #
## Header 2 ##
### Header 3 ###

The closing # characters are optional.

Rule #1
---
Rule #2
*******
Rule #3
___

Using spaces between the characters also works:

Rule #4
- - - -

You can also press CTRL+R to insert a horizontal rule.

A double-spaced list:

- This list gets wrapped in <p> tags
 
- So there will be extra space between items

1. Lists in a list item:
    - Indented four spaces.
        * indented eight 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.
 
    We indented the first line an extra space to align
    it with these paragraphs. In real use, we might do
    that to the entire list so that all items line up.
 
    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, as we did with the first two.
 
3. Blockquotes in a list item:
 
    > Skip a line and
    > indent the >'s four spaces.
 
4. Preformatted text 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.

To put other Markdown blocks in a blockquote, just add a > followed by a space:

> The `>` on the blank lines is required
> to create a single blockquote.
> 
> If you leave out the extra `>`
> you will end up with
> two distinct blockquotes.

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

Preformatted text in a blockquote:

>     Indent five spaces total.  The first
>     one is part of the blockquote designator.

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 ![valid XHTML][checkmark].

[checkmark]: https://w3.org/Icons/valid-xhtml10
             "What are you smiling at?"

Note: Markdown does not currently support the shortest reference syntax for images:

Here's a broken ![checkmark].

But you can use a slightly more verbose version of implicit reference names:

This ![checkmark][] 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="https://example.com/sample.png" width="100" height="100">

URLs can be relative or full.

Markdown and HTML are ignored within a code block:

    You will see *stars* here, but no italics.

Monospace Spans

Use backticks to create an inline span of preformatted text:

If your browser's location bar starts with `https://`, then the connection is encrypted.

(The backtick key is in the upper left corner of most keyboards.)

The text between the backticks will be displayed in a monospaced font, just like the preformatted blocks.

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:

1. They must be separated from surrounding text by blank lines.
2. The begin and end tags of the outermost block element must not be indented.
3. Markdown can't be used within HTML blocks.

<pre>
    You can <em>not</em> use Markdown in here.
</pre>

Supported shorthand links:

• [meta] – link to the current site's Meta; link text is the site name (e.g. "Super User Meta"). Does nothing if the site doesn't have (or already is) a Meta site.

• [main] – like [meta], just the other way around.

• [edit] – link to the edit page for the post the comment is on, i.e. /posts/{id}/edit. Link text is "edit" (capitalization is respected).

• [tag:tagname] and [meta-tag:tagname] – link to the given tag's page. Link text is the name of the tag.meta-tag only works on meta sites.

• [help], [help/on-topic], [help/dont-ask], [help/behavior] and [meta-help] – link to frequently visited pages of the help center. Link text is "help center" (capitalization is respected). All links point to the main site.

• [tour] – link to the Tour page. Link text is "tour" (capitalization is respected).

• [so], [pt.so], [su], [sf], [metase], [a51], [se] – link to the given site. Link text is the site name.

• [chat] – link to the current site's chat site, the link text being "{site name} Chat".

• [ask], [what you are asking], [answer] – link to the How to Ask or How to Answer page.

• [code block] – link to the markdown editing help page. Link text is "code block".

• [something.se] – link to something.stackexchange.com, if that site exists. Link text is the site name. Use [ubuntu.se] for Ask Ubuntu.