CrunchBang - Code, Design & GNU/Linux

LAST EDIT: Monday, May 5th, 2008

Markdown Syntax

My blog, wiki and comments system all employ Markdown. See syntax below:

Phrase Emphasis

*italic*   **bold**
_italic_   __bold__

Links

Inline:

An [example](http://url.com/ "Title")

Reference-style labels (titles are optional):

An [example][id]. Then, anywhere else in the doc, define the link:

  [id]: http://example.com/  "Title"

Autolinks

<http://crunchbang.org>

Will produce:

<a href="http://crunchbang.org">http://crunchbang.org</a>

See, http://crunchbang.org :)

Images

Inline (titles are optional):

![alt text](/path/img.jpg "Title")

Reference-style:

![alt text][id]

[id]: /url/to/img.jpg "Title"

Headers

Setext-style:

Header 1
========

Header 2
--------

atx-style (closing #'s are optional):

# Header 1 #

## Header 2 ##

###### Header 6

Lists

Ordered, without paragraphs:

1.  Foo
2.  Bar

Unordered, with paragraphs:

*   A list item.

With multiple paragraphs.

*   Bar

You can nest them:

*   Abacus
    * answer
*   Bubbles
    1.  bunk
    2.  bupkis
        * BELITTLER
    3. burper
*   Cunning

Blockquotes

> Email-style angle brackets

> are used for blockquotes.

> > And, they can be nested.

> #### Headers in blockquotes
> 
> * You can quote a list.
> * Etc.

Code Spans

`<code>` spans are delimited by backticks.

You can include literal backticks like `` `this` ``.

Preformatted Code Blocks

Indent every line of a code block by at least 4 spaces or 1 tab.

This is a normal paragraph.

    This is a preformatted
    code block.

Horizontal Rules

Three or more dashes or asterisks:

---

* * *

- - - -

Manual Line Breaks

End a line with two or more spaces:

Roses are red,   
Violets are blue.

Backslash Escapes

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formatting syntax. For example, if you wanted to surround a word with literal asterisks (instead of an HTML <em> tag), you can use backslashes before the asterisks, like this:

\*literal asterisks\*

Markdown provides backslash escapes for the following characters:

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark

Definitions

Term 1

:   This is a definition with two paragraphs. Lorem ipsum 
    dolor sit amet, consectetuer adipiscing elit. Aliquam 
    hendrerit mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus.

:   Second definition for term 1, also wrapped in a paragraph
    because of the blank line preceding it.

Term 2

:   This definition has a code block, a blockquote and a list.

        code block.

    > block quote
    > on two lines.

    1.  first list item
    2.  second list item

Abbreviations

Define a list of abbreviations like so:

*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium


The HTML specification is maintained by the W3C.

Footnotes

That's some text with a footnote.[^1]

[^1]: And that's the footnote.

That's the second paragraph.

External links

• Markdown [original] - http://daringfireball.net/projects/markdown/
• PHP Markdown - http://www.michelf.com/projects/php-markdown/
• Markdown Wiki - http://markdown.infogami.com/