Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > Reference Info > Lists > Markdown Syntax

Markdown Syntax

You can now use markdown syntax in the description fields for ServerTemplates, RightScripts, and Deployments.  This makes your descriptions more readable.

Text Formatting

*italic*   **bold**
_italic_   __bold__

How do I escape text formatting?

In some cases you may have a filename that includes underscores. In such cases, you want to make sure that the filname is properly displayed and not accidentally italicized. Use backslashes to escape characters.  For example, if you have a text string called 'my_first_name' you will need to change it to 'my\_first\_name' otherwise it will appear as 'myfirstname' in the UI.

Links

Inline:

An [example](http://url.com/ "Title")

Reference-style labels (titles are optional):

An [example][id]. Then, anywhere
else in the doc, define the link:

[id]: http://example.com/ "Title"

Images

Inline (titles are optional):

![alt text](/path/img.jpg "Title")

Reference-style: 

The [id] must be the same in both rows.  If you add an image from an external site, you can get challenged with a "do you want to display the nonsecure items" message depending on your browser settings.

![alt text][id]

[id]: http://www.mydomain.com/images/image.jpg "Title"

Headers

Setext-style:

Header 1
========

Header 2
--------

atx-style (closing #'s are optional):

# Header 1 #

## Header 2 ##

###### Header 6

Lists

Ordered, without paragraphs:

1.  Foo
2. Bar

Unordered, with paragraphs:

*   A list item.

With multiple paragraphs.

* Bar

You can nest them:

*   Abacus
* answer
* Bubbles
1. bunk
2. bupkis
* BELITTLER
3. burper
* Cunning

Horizontal Rules

Three or more dashes or asterisks:

* * *

- - - -

 

Line Breaks

For line breaks, on the space between paragraphs, add three #'s followed by two spaces

###  


 

You must to post a comment.
Last modified
10:12, 28 Feb 2014

Tags

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.