Contents

Markdown

We use Markdown formatting in the forum, user info (at profile page) and few other places. You can find full documentation at official page.

Meanwhile here are collection of few most important rules and tips.


Paragraphs and line breaks

Text separated by empty lines is placed into separate paragraphs.

Let's see an example:

Text separated by empty lines                       paragraph 1
is placed into separate paragraphs

Let's see an example:                               paragraph 2

It is also
possible
to insert
implicit line breaks inside a single paragraph - simply add a two spaces at the end of the line before the break:

It is also                              <-- this line have two extra spaces at the end
possible                                <-- this too
to insert                               <-- and this
implicit                                <-- all remaining lines do not have trailing spaces
line breaks
inside a single
paragraph

Bold and Italics

Emphasizing text with Bold or Italics is done by surrounding it with double or single asterics:

Emphasizing text with **Bold** or *Italics* is done...

Code blocks

To create a code block like the following:

int main(int argc, char**argv) {
    printf("Hi, Peoplezzz!\n");
}

The lines should be indented with four spaces or more. For example:

To create a code block like the following:

    int main(int argc, char**argv) {
        printf("Hi, Peoplezzz!\n");
    }

It is also possible to inline smaller blocks for writing names of functions like printf or languages like Oberon. This is achieved by enclosing the fragment into backtics:

...names of functions like `printf` or...

Links and Images

Links are added by joining two fragments - text of the link inside square brackets - and address inside round ones. So link like Wiki on Markdown is created with:

[Wiki on Markdown](http://en.wikipedia.org/wiki/Markdown)

Images are inserted in the similar manner - only prepended with an exclamation mark. Text inside square brackets should contains small description placed inside alt attribute (for cases when image could not be rendered and for search engines):

![Demo Image insertion with Markdown](http://www.codeabbey.com/img/viewdemo.gif)

Demo Image insertion with Markdown

Of course if you want to insert a custom image, you will probably need to upload it to some special resource, for example http://postimage.org and copy the link.


Lists

To create a list without numbers you create the paragraph each line of which is started with dashes or asterics:

To create a numbered list you do almost the same, but lines are started with number-and-dot (any number will go!).

  1. First item
  2. Second item
  3. Third item

For example:

To create a list without...

- Python
- Java
- PHP

To create a numbered list...

1. First item
1. Second item
3. Third item

Practice

You can find several online editors for markdown if you want to get acquainted with it, for example Markable.