Using Markdown in the Developer Portal

CSS is great for decorating your portal, but if you want to control how the content will display, you will need to use Markdown. Markdown is a great way to easily and effectively use HTML type formatting without learning any of the HTML syntax. This guide will cover some of the most commonly used Markdown elements.

Headers links Anchor Links
Lists Code Blockquotes

Headers

Headers are a way to identify new sections or sub sections of text. They range in size from 1 - 6 with 1 being the largest and 6 being the smallest. A header is identified with a # in markdown:

# Header size 1
## Header Size 2
### Header size 3
#### Header size 4
##### Header size 5
######v Header Size 6

Will display as:

Header size 1

Header Size 2

Header size 3

Header size 4

Header size 5
Header Size 6

Links

To create a link in Markdown, you will start with the words you want displayed in square brackets [ and ] followed by the URL you want the link to go to in normal parentheses ( and ). So, if you enter

[this is clickable text](https://www.mashape.com/)

Will display as:

this is clickable text

Anchor Links

Sometimes, you will want to link to something on the same page you are currently on. This is referred to as an anchor link. To use anchor links in markdown,

[Clickable Text](#blockquotes)
I am going to have this link go to the BlockQuotes section. At the top of that section, I added the second half of the anchor link,
<a id='blockquotes'></a>

It will display and work like this:

Clicking on this Clickable Text will take you to the Blockquotes of this guide.


Lists

Lists are a great way to show things as a group in a document. Gelato supports unordered lists (sometimes referred to a bullet lists) and Ordered Lists (sometimes called numbered lists).

For an unordered list

* You can use an asterisks
- Or minuses
+ Or pluses

Will display as:

  • You can use an asterisks
  • Or minuses
  • Or pluses

To use an ordered list, you can simply:

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

Which will display as:

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

Code

Often times, you will want to show code in your portal. To avoid having your code picked up as markdown, you will need to wrap it in `

```int find(x) { return parent[x] = (x == parent[x] ? x : find(parent[x]); }```

Will display the code as

int find(x) { return parent[x] = (x == parent[x] ? x : find(parent[x]); }

Blockquotes

Blockquotes are a handy way to separate a part of writing out to bring attention to it.

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed 
>diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Will display:

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed

diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.