Developer Center

Resources to get you started with Algorithmia

Markdown Syntax

Updated

When you are ready to write the documentation for your algorithm under the “Docs” tab on your algorithm’s page, you can use markdown to make your documentation clear.

Algorithmia’s description editor is a CommonMark markdown editor with auto-link and GFM table support.

Basic formatting

*italics*
_italics_
**bold**
__bold__
~~strikethrough~~

Headers

## Medium header
### Small header
#### Tiny header

We recommend avoiding H1 level headers (single #) as it may negatively impact discoverability (i.e. SEO) of your algorithm.

Lists

* Bullet list item
* Bullet list item
* Bullet list item

1. Numbered list item
2. Numbered list item
3. Numbered list item
[Text to display](http://www.example.com)

Bare URLs will also be automatically converted to links.

Quotes

> This is a quote.
> It can span multiple lines!

Images

![](http://www.example.com/image.jpg)

Videos

You can add mp4 videos using the HTML <video> tag.

<video src="https://example.com/demo.mp4"></video>

Tables

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| John     | Doe      | Male     |
| Mary     | Smith    | Female   |

Aligning the column separators is optional. This table renders the same:

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| John | Doe | Male |
| Mary | Smith | Female |

You may also specify the rendered alignment of each column:

| Left-aligned    | Center-aligned      | Right-aligned |
| :-----------    | :------------:      | ------------: |
| Example         | Expensive item      | $1600 |
| Another example | Less expensive item | $900 |

Code

Inline code is specified with single tick marks:

`var example = "hello!";`

Multi-line code-fenced blocks will auto-detect language for code highlighting:

```
var example = "hello!";
alert(example);
```

You can also explicitly specify language for code-fenced blocks:

```json
{
  "name": "jane"
}
```

If you want to disable code-highlighting, use text as the explicitly specified language.