Vultr Flavored Markdown Tutorial

Last Updated: Mon, Jul 6, 2020
Vultr Docs

Introduction

When writing for the Vultr Docs library, use Markdown format. Markdown, designed by John Gruber, is a lightweight markup language with formatting in plain text. Use this quick reference when formatting your article in Vultr Flavored Markdown. More information about Markdown formatting is available on the Markdown homepage.

The main differences between Markdown and Vultr Flavored Markdown are as follows:

  • Vultr Markdown does not allow inline HTML. You may only use plain text with Markdown formatting.
  • Links must start with either the http:// or https:// URL scheme. Other URL schemes are stripped.
  • Vultr Markdown does not support image links. If you would like to add an image, place a link to the image where you would like it to appear in your article. Our team will add it when publishing your article.

Before submitting your article, please verify your formatting with the preview tab on the submission page.

The source Markdown file for this article is available as an example reference.


Paragraphs and Line Breaks

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. Normal paragraphs should not be indented with spaces or tabs.

Paragraph with line breaks

Add two spaces at the end of a line to force a line break.
A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. Normal paragraphs should not be indented with spaces or tabs.


Headers

NOTE: H1 headings are added automatically at the top of each Vultr doc. H1 tags are not permitted.

## This is an H2

### This is an H3

#### This is an H4

##### This is an H5

###### This is an H6

This is an H2

This is an H3

This is an H4

This is an H5
This is an H6

Blockquotes

> This is a **blockquote** with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.

Nested blockquote

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Return to the first level blockquote.

This is the first level of quoting.

This is nested blockquote.

Return to the first level blockquote.


Lists

Unordered list

* Red
* Green
* Blue
  • Red
  • Green
  • Blue

Ordered list

1. Bird
2. McHale
3. Parish
  1. Bird
  2. McHale
  3. Parish

Ordered list with 2 paragraphs

1. This is a list item with two paragraphs. Indent the second 
paragraph 4 spaces to align with the list. 

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, 
    risus. Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

2. This is the second list item.
  1. This is a list item with two paragraphs. Indent the second paragraph 4 spaces to align with the list.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

  2. This is the second list item.


Code Blocks

Code blocks are indented with 4 spaces.

tell application "Foo"
    beep
end tell

Inline code

Use the printf() function.

There is a literal backtick (`) here.

Please don't use <blink> tags.

&#8212; is the decimal-encoded equivalent of &mdash;.

Code blocks in Lists

Code blocks in lists are indented by 8 spaces. The first 4 spaces make it a part of the list, the next 4 spaces make it a code block.

  1. Compile the following code:

    tell application "Foo"
        beep
    end tell
    
  2. Run the program.

  3. Check the output.

Horizontal Rules

Use three hyphens to make a horizontal rule.

---

Inline links

This is [an example](http://example.com/ "The Link Title") inline link, titled "The Link Title".  
[This link](http://example.net/) has no title attribute.  
Return to the [Index](/) page.  

This is an example inline link, titled "The Link Title".
This link has no title attribute.
Return to the Index page.

Reference links

Find us on [Google][]  

[Google]: http://google.com/

Some popular search engines are [Google] [1],
[Yahoo] [2], and [MSN] [3].  

[1]: http://google.com/        "Google"
[2]: http://search.yahoo.com/  "Yahoo Search"
[3]: http://search.msn.com/    "MSN Search"

Find us on Google

Some popular search engines are Google, Yahoo, and MSN.

Automatic links

Make automatic links for URLs and email addresses:
<http://example.com/> and <address@example.com>  

Make automatic links for URLs and email addresses: http://example.com/ and address@example.com


Emphasis

*single asterisks*  
_single underscores_  
**double asterisks**  
__double underscores__  
middle**of**word  

single asterisks
single underscores
double asterisks
double underscores
middleofword

Note: It's common to have variable names in technical documents with underscores. Be careful to escape your underscores if you are referring to a string with literal underscores outside a code block. See examples:

THE\_EXAMPLE\_VARIABLE

THE_EXAMPLE_VARIABLE

THE_EXAMPLE_VARIABLE

THEEXAMPLEVARIABLE


Special Characters

Use a backslash to escape special characters.

\*this text is surrounded by literal asterisks\*  
\\ \` \* \_ \{\} \[\] \(\) \# \+ \- \. \!  

*this text is surrounded by literal asterisks*
\ ` * _ {} [] () # + - . !


Automatic Escaping for Special Characters

Copyright HTML entity

&copy;  

©

Ampersands are converted automatically without delimiters.

AT&T

AT&T

Angle brackets are also converted properly without delimiters.

4 < 5 = 5 > 4

4 < 5 = 5 > 4


Keyboard

Literal keystrokes are represented with short-codes.

Function Keys

:key_f1: :key_f2: :key_f3: :key_f4: :key_f5: :key_f6: :key_f7: :key_f8: :key_f9: :key_f10: :key_f11: :key_f12:

F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12

Symbols

:key_tilde: :key_grave: :key_exclamation: :key_at: :key_pound: :key_dollar: :key_percent: :key_carat: :key_ampersand: :key_asterisk: :key_lparen: :key_rparen: :key_dash: :key_underscore: :key_plus: :key_equals: :key_lbracket: :key_lbrace: :key_rbracket: :key_rbrace: :key_pipe: :key_backslash: :key_semicolon: :key_colon: :key_quote: :key_apostrophe: :key_lt: :key_comma: :key_gt: :key_period: :key_question: :key_forwardslash: :key_space: :key_spacebar:

~ ` ! @ # $ % ^ & * ( ) - _ + = [ { ] } | \ ; : " ' < , > . ? / SPACE SPACE

Special Keys

:key_esc: :key_backspace: :key_tab: :key_caps: :key_capslock: :key_enter: :key_return: :key_shift: :key_control: :key_ctrl: :key_super: :key_win: :key_command: :key_alt: :key_meta: :key_printscreen: :key_sysrq: :key_scrolllock: :key_pause: :key_break: :key_delete: :key_end: :key_pagedown: :key_pgdn: :key_insert: :key_home: :key_pageup: :key_pgup: :key_up: :key_left: :key_down:
:key_right: :key_numlock:

ESC BACKSPACE TAB CAPS CAPS ENTER RETURN SHIFT CTRL CTRL SUPER WIN COMMAND ALT META PRINTSCREEN SYSRQ SCROLLLOCK PAUSE BREAK DELETE END PGDN PGDN INSERT HOME PGUP PGUP UP LEFT DOWN RIGHT NUMLOCK

Alpha Numeric

:key_a: :key_b: :key_c: :key_d: :key_e: :key_f: :key_g: :key_h: :key_i: :key_j: :key_k: :key_l: :key_m: :key_n: :key_o: :key_p: :key_q: :key_r: :key_s: :key_t: :key_u: :key_v: :key_w: :key_x: :key_y: :key_z:

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

:key_1: :key_2: :key_3: :key_4: :key_5: :key_6: :key_7: :key_8: :key_9: :key_0:

1 2 3 4 5 6 7 8 9 0

Example usage:

Save the file by pressing :key_ctrl: + :key_x:, then :key_y:.

Save the file by pressing CTRL + X, then Y.


Tables

TableExample

Column 1 Column 2 Column 3
Data 1 Data 2 Data 3
Data 4 Data 5 Data 6

Want to contribute?

You could earn up to $300 by adding new articles