Use Vultr Flavored Markdown when writing for Vultr Docs. Vultr-Flavored Markdown is a hybrid of basic Markdown and Vultr's in-house, non-standard extensions. Please pay special attention to tables, code blocks, and keystroke symbols. The main features of Vultr Flavored Markdown that vary from other common Markdown flavors are:
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 table formatting differs from most other Markdown variants.
Tables do not support popular features like alignment or zebra-stripes.
Vultr has a special syntax to represent keystrokes.
Code block do not support highlighting.
To check your formatting, please use the Preview tab in the article submission form. Unfortunately, you'll notice some differences between our preview function and how Vultr Docs renders the page:
Embedded images will not display in your preview.
Table formatting and alignment will be different.
Whitespace between elements is different.
For best results, please follow these guidelines.
Example:
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.
Result:
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.
Example:
Add two spaces at the end of a line to force a line break.
Add two spaces at the end of a line to force a line break.
Add two spaces at the end of a line to force a line break.
Result:
Add two spaces at the end of a line to force a line break.
Add two spaces at the end of a line to force a line break.
Add two spaces at the end of a line to force a line break.
Vultr automatically adds the article title as an H1 heading when publishing. Do not include H1 (#) in your article.
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Example:
> 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.
Result:
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.
Example:
> This is the first level of quoting.
>
>> This is nested blockquote.
>
> Return to the first level blockquote.
Result:
This is the first level of quoting.
>
This is nested blockquote.
>
Return to the first level blockquote.
Example:
* Red
* Green
* Blue
Result:
Red
Green
Blue
Example:
1. Bird
2. McHale
3. Parish
Result:
Bird
McHale
Parish
Example:
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.
Result:
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.
This is the second list item.
Code blocks are indented with 4 spaces at the beginning of each line. Do not use tabs. Do not use backticks or fenced code blocks.
Example:
<- Beginning of line
int main() {
std::cout << "Hello World!";
return 0;
}
Use a single backtick for inline code.
Example:
Use the `printf()` function.
Result:
Use the printf() function.
Wrap a command with two backticks if you need to show a literal backtick.
Example:
There is a ``literal backtick (`)`` here.
Result:
There is a literal backtick (`) here.
Code blocks in lists are indented by eight spaces at the beginning of each line. Text indented by four spaces become part of the list item.
Example:
1. This is item one.
Here is the code for item one.
int main() {
std::cout << "Hello World!";
return 0;
}
2. This is item two.
3. This is item three.
Result:
This is item one.
Here is the code for item one:
int main() {
std::cout << "Hello World!";
return 0;
}
This is item two.
This is item three.
Use three hyphens to make a horizontal rule.
Example:
---
Result:
We support inline links, which are preferred for ease of editing and review. Please do not use reference-style links.
Example:
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.
Result:
This is an example inline link, titled "The Link Title".
This link has no title attribute.
Please do not use reference-style links, like this example:
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"
Wrap URLs with angle brackets to make an automatic link.
Example:
Make automatic links: <http://example.com/> and <address@example.com>
Result:
Make automatic links: http://example.com/ and address@example.com
Example:
*single asterisks make italic text*
_single underscores make italic text_
**double asterisks make bold text**
__double underscores make bold text__
This also works in the middle**of**words
Result:
single asterisks make italic text
single underscores make italic text
double asterisks make bold text
double underscores make bold text
This also works in the middleofwords
It's common to have variable names in technical documents with underscores. Be careful to escape your underscores!
Correct:
THE\_EXAMPLE\_VARIABLE
THE_EXAMPLE_VARIABLE
Incorrect:
THE_EXAMPLE_VARIABLE
THEEXAMPLEVARIABLE
Use a backslash to escape special characters.
Example:
\*this text is surrounded by literal asterisks\*
\\
\`
\*
\_
\{\}
\[\]
\(\)
\#
\+
\-
\.
\!
Result:
*this text is surrounded by literal asterisks*
\
`
*
_
{}
[]
()
#
+
-
.
!
Copyright HTML entity:
©
©
Ampersands and angle brackets are converted automatically without delimiters.
AT&T
4 < 5 = 5 > 4
AT&T
4 < 5 = 5 > 4
Represent literal keystrokes with short-codes, and distinguish uppercase/lowercase with the shift key.
:key_x: is a lowercase "x".
:key_shift:+:key_x: is an uppercase "X".
X is a lowercase "x".
SHIFT+X is an uppercase "X".
Save the file by pressing :key_ctrl:+:key_x:, then :key_y:.
Result:
Save the file by pressing CTRL+X, then Y.
: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:
Result:
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:
Result:
1 2 3 4 5
6 7 8 9 0
:key_f1: :key_f2: :key_f3: :key_f4: :key_f5: :key_f6:
:key_f7: :key_f8: :key_f9: :key_f10: :key_f11: :key_f12:
Result:
F1 F2 F3 F4 F5 F6
F7 F8 F9 F10 F11 F12
: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:
Result:
~ ` ! @ #
$ % ^ & *
( ) - _ +
= [ { ] }
| \ ; : "
' < , > .
? / SPACE SPACE
: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:
Result:
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
Vultr-flavored Markdown does not support tables of any type.