Markdown Essentials

Markdown main site

GitHub Flavored Markdown Guide


A paragraph is one or more consecutive lines of text separated by one or more blank lines. A blank line contains nothing but spaces or tabs.

Do not indent normal paragraphs with spaces or tabs. Indent at least 4 spaces or a tab for code blocks.

Syntax highlighted code block

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

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)


*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

Emphasis can be used in the mi\*dd\*le of a word.


# H1
## H2
### H3
#### H4
##### H5
###### H6


[ Text for the link ](URL)

This is [an example][id] reference-style link.
[id]: http://example.com/  "Optional Title Here"

![Alt text](/path/to/img.jpg "Optional title")


`span of code`


def wiki_rocks(text):
    formatter = lambda t: "funky"+t
    return formatter(text)

will be displayed as

def wiki_rocks(text):
    formatter = lambda t: "funky"+t
    return formatter(text)


> This is a blockquote with two paragraphs. 
> Second paragraph.

GitHub Pages

GitHub Pages documentation

GitHub Pages site will use the layout and styles from the Jekyll theme you have selected in your repository settings. The name of this theme is saved in the Jekyll _config.yml configuration file.


Bitbucket doesn't support arbitrary HTML in Markdown, it instead uses safe mode. Safe mode requires that you replace, remove, or escape HTML tags appropriately.

Code highlighting to bitbucket README.md written in Python Markdown

    friends = ['john', 'pat', 'gary', 'michael']
    for i, name in enumerate(friends):
        print "iteration {iteration} is {name}".format(iteration=i, name=name)

Python markdown main site

Cloning your Bitbucket Wiki

$ git clone http://bitbucket.org/MY_USER/MY_REPO/wiki