More than 5 years have passed since last update.

Markdown Cheatsheet

Last updated at 2014-06-16Posted at 2013-01-28

Please refer to [Daring Fireball: Markdown Syntax Documentation]
(http://daringfireball.net/projects/markdown/syntax.php) for the original documentation of Markdown.
Also, the code notation is implementad in relation with GitHub Flavored Markdown.

Code - Code Insertion

For example, if you want to write down a ruby source code with a file name "kobito.rb", use backquote to apply syntax highlighting.
It may not function normally when there is no blank lines before and after a code block.

(blank line)
```ruby:kobito.rb
puts 'The best app to log and share programming knowledge.'
```
(blank line)

result

qiita.rb

puts 'The best app to log and share programming knowledge.'

It is also possible to display codes with in-line style.

` puts 'Kobito'` is a technical knowledge archiving application for programmers.

Result

puts 'Kobito' is a technical knowledge archiving application for programmers.

Format Text - text-decoration

Headers

# This is an H1 tag.
## This is an H2 tag.
###### This is an H6 tag.

Emphasis

*This is in italics*
_This is also in italics._
_This_will not be in italics.
**This is in bold.**
_\This is also in bold.__

Lists

Unordered (bulleted) lists

Putting "*", "+" or "-" at the beginning of a sentence makes unordered lists.
Convenient for summarizing points.
When inserting lists, you need to add blank lines before and after the lists.

Ordered (numbered) lsits

Putting numbers followed by periods (e.g. "1.") at the beginning of a sentence makes decimal style lists.
When inserting lists, you need to add blank lines before and after the lists.

Blockquotes

> Putting > at the beginning of a sentence makes quotations.
> If you want to quote more than two lines, you need to put the mark every line.
> You need to insert blank lines before and after quotations.
> You can use other Markdown syntax inside a quotation.

This is a nested quotation.

Horizontal rules

All of following marks make a horizontal line.

* * *
***
*****
- - -
---------------------------------------

Images - Embedding images

![Alternative text](URL of an image)
- Embedding an image without a title
![Alternative text](URL of an image)
- Embedding an image with its title

Example

Markdown: ![Qiita](http://qiita.com/favicon.png "Qiita")
Result:

Tables

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       |        This |     This     |
| column     |      column |    column    |
| will       |        will |     will     |
| be         |          be |      be      |
| left       |       right |    center    |
| aligned    |     aligned |   aligned    |

This will be displayed as follows.

Left align	Right align	Center align
This	This	This
column	column	column
will	will	will
be	be	be
left	right	center
aligned	aligned	aligned

Others

Inserting backslash[\] before Markdown syntax can escape Markdown.