Contribution

Introduction

If you wish to contribute to this document, you must have a basic knowledge of MarkDown documents and how to write them. We have written a markdown beautify that changes documents from basic text to a beatiful document that looks like this one you are reading write now.

They are various tutorials about how to write markdown documents all over the internet, however we tried to summarize what we think that are most needed knowledge you may need in order to contribute to this documentation.

Mark down tutorials

Section Headings

You can define headings of different levels when creating a documents. The most important heading (which typically only occurs once on each page -- at the top) is heading 1. A level 1 heading can be created with Markdown by typing a single '#' character at the start of a line. The heading at the top of this page was defined like this:

    # Contribution

To create a secondary heading (such as the one for this section) you just use two '#' characters, like so:

    ## Section Headings

You can use up to six '#' characters to create a level 6 heading, but you will probably find that you don't need to nest your headings quite so deeply!

Paragraphs

Paragraphs are very easy; separate them with a blank line. You can write your paragraph on one long line, or you can wrap the lines yourself if you prefer.

This section was marked up like so:

    Paragraphs are very easy; separate them with a blank line. You can write your paragraph on one long line,
    or you can
    wrap the lines yourself
    if you prefer.

    This section was marked up like so:
    Bold and Italics
    It's very easy to add emphasis with bold and italics:

It's very easy to do bold and italics: You can also use underscores if you prefer:

    It's **very** easy to do **bold** and *italics*:

Links

Create simple links by wrapping square brackets around the link text and round brackets around the URL:

    [Havanao](https://api.havanao.com)

If you want to give your readers an extra about the link that they're about to follow you can set a link title:

    [Havanao](https://api.havanao.com "Havanao is awesome !")

Titles usually appear as a tooltip when you hover over the link, and help search engines work out what a page is about.

Bulleted Lists

Start each line with hyphen or an asterisk, followed by a space. List items can be nested. This text:

    * Bullet 1
    * Bullet 2
      * Bullet 2a
      * Bullet 2b
    * Bullet 3

...produces this list:

Numbered Lists

Start each line with number and a period, then a space. This text…

    1. Baked potato
    2. Baked beans
    3. Pepper

...produces this list:

  1. Baked potato
  2. Baked beans
  3. Pepper

Quotes

If you need to cite a paragraph of somebody else's work you really ought to attribute it to them properly by using HTML's <blockquote/> tag. You can produce it with Markdown by adding a single '>' character at the beginning of the line.

This text:

    > For God so loved the world that he gave his one and only Son, 
    > that whoever believes in him shall not perish but have eternal life.
    > - John 3:16

...produces:

For God so loved the world that he gave his one and only Son, that whoever believes in him shall not perish but have eternal life.

  • John 3:16