Skip to content

Latest commit

 

History

History
140 lines (114 loc) · 4.01 KB

cheatsheet.md

File metadata and controls

140 lines (114 loc) · 4.01 KB
layout title categories weight parent
bt_wiki
Cheat Sheet
HOWTO
700
none

{%summary%} Lists the common macros for the Cloudify documentation and how to use them{%endsummary%}

Text

{: .table .table-bordered} | Example | Markdown | | This is an emphasised text. | This is an *emphasised* text. | | This is a bold text. | This is a **bold** text. | | This is a monospaced text | This is a `monospaced` text |

Links

{: .table .table-bordered} | Description | Markdown | Output | | Link to external site | [GigaSpaces](http://www.gigaspaces.com\) | GigaSpaces | | Link to page in same folder | [Directory Structure](file-structure.html) | Directory Structure |

Panels

Example Markdown
{% highlight python linenos %} class Hangman(object):
def __init__(self, word, num_attempts):
    self.word = word
    self.num_attempts = num_attempts
    self.attempts_left = num_attempts
    self.status_arr = ['?' for _ in word]

{%endhighlight%}

{%raw%}
{% highlight python linenos %}
class Hangman(object):

def __init__(self, word, num_attempts):
    self.word = word
    self.num_attempts = num_attempts
    self.attempts_left = num_attempts
    self.status_arr = ['?' for _ in word]

{%endhighlight%}

Languages: yaml python {%endraw%}
{%tip title=Foo%}this is a Tip panel {%endtip%}{%raw%} {%tip title=Foo%}this is a Tip panel {%endtip%} {%endraw%}
{%info title=Foo%}this is an Information panel {%endinfo%}{%raw%} {%info title=Foo%}this is an Information panel {%endinfo%} {%endraw%}
{%note title=Foo%}this is a Note panel {%endnote%}{%raw%} {%note title=Foo%}this is a Note panel {%endnote%} {%endraw%}
{%warning title=Foo%}this is a Warning panel {%endwarning%}{%raw%} {%warning title=Foo%}this is a Warning panel {%endwarning%} {%endraw%}
{%quote%}This is a quote{%endquote%}{%raw%} {%quote%}This is a quote{%endquote%} {%endraw%}

Layout

Table with borders

{: .table .table-bordered}

Header1 Header2 Header3
column1 column2 column3

Markdown:

{: .table .table-bordered}
| Header1 | Header2 | Header3 |
|:--------|:--------|:--------|
| column1 | column2 | column3 |

Table without borders

{: .table }

Header1 Header2 Header3
column1 column2 column3

Markdown:

| Header1 | Header2 | Header3 |
|:--------|:--------|:--------|
| column1 | column2 | column3 |

Tabbed Pane

Example Markdown
{% inittab %} {% tabcontent Foo %} This is tab Foo {% endtabcontent %} {% tabcontent Bar %} This is tab Bar {% endtabcontent %} {% endinittab %}
{%raw%}
{% inittab %}
{% tabcontent Foo %} This is tab Foo {% endtabcontent %}
{% tabcontent Bar %} This is tab Bar {% endtabcontent %}
{% endinittab %}
{%endraw%}

Cloak

Example Markdown
{% togglecloak id=1 %} **Click Here...**{% endtogglecloak %} {% gcloak 1 %} - Foo - Bar {% endgcloak %}
{%raw%}
{% togglecloak id=1 %}  **Click Here...**{% endtogglecloak %}
{% gcloak 1 %}
- Foo
- Bar
{% endgcloak %}
{%endraw%}

Macros

{: .table .table-bordered} | Description | Macro | Output | | Latest Cloudify Release version | {%raw%} {%latestcloudifyrelease%} {%endraw%} | {%latestcloudifyrelease%} |