cheatsheet.markdown

layout	title	published	sorting	alias
default	Markdown Cheatsheet	true	1	markdown-cheatsheet.html

Markdown formatting is simple, and the CFEngine generator adds a few things to make it even simpler. Here's a list of the most commonly used formats.

Basic Formatting

One
Paragraph

Two
Paragraphs

One Paragraph

Two Paragraphs

**Bold** Bold

*Italic* Italic

Links

Link within documentation and to known pages

[top of the page][Markdown Cheatsheet] and [inside page][Markdown Cheatsheet#Links]

[top of the page][Markdown Cheatsheet] and [inside page][Markdown Cheatsheet#Links]

Note: For known pages, see the _references.markdown file.

Link to CFEngine keyword

The documentation pre-processor will create those automatically.

`classes` and `readfile()`

classes and readfile()

Link to External URL

[Markdown Documentation](http://daringfireball.net/projects/markdown/)

Markdown Documentation

Lists

Unordered lists - Markdown supports other markers than the asterisk, but in CFEngine we use only *.

* Item 1
* Item 2
   * Item 2a
* Multi paragraph item

    Four spaces indented

• Item 1

• Item 2

  • Item 2a

• Multi paragraph item

  Four spaces indented

Ordered lists - the numbers you use don't matter.

1. first
1. second
9. Third

1. first
2. second
3. Third

Tables

Wiki-syntax for tables is supported, and you can be a bit sloppy about it, although it's better to align the | properly.

| Header | Left aligned | Centered | Right aligned |
|--------|:-------------|:--------:|--------------:|
|text    | text | X | 234 |

Header	Left aligned	Centered	Right aligned
text	text	X	234

Code

Code Blocks

Just indent by four spaces:

    $ code block
    $ without syntax highlighting

$ code block
$ without syntax highlighting

If you want CFEngine syntax highlighting, use

```cf3
    # CFEngine block

    bundle agent example()
    {
    }
```

    # CFEngine code block

    bundle agent example()
    {
    }

Notes: You need to keep an empty line in front of the code block. And to put code into a list item, the code needs to be indented twice, ie:

• List item with code

    <code goes here>
  

* List item with code

        <code goes here>

Inline code

This renders as `inline code`.

This renders as inline code.

---

Headers

Horizontal bar

***

---

# Level 1

Level 1

## Level 2

Level 2

### Level 3

Level 3

#### Level 4

Level 4

##### Level 5

Level 5

###### Level 6

Level 6

---