Skip to content

Latest commit

 

History

History
561 lines (382 loc) · 11.2 KB

cheatsheet.markdown

File metadata and controls

561 lines (382 loc) · 11.2 KB
Raw
layout title published sorting alias
printable
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

Remember

  • "Always pull never push"

Basic Formatting

One
Paragraph

Two
Paragraphs

One Paragraph

Two Paragraphs

**Bold** Bold

*Italic* Italic

Links

Link within documentation and to known pages

You can link to any documentation page section using [linktext][PageTitle#optional section].

For example I can link to [collecting functions][Functions#collecting functions] using [collecting functions][Functions#collecting functions].

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

top of the page, to the Markdown Cheatsheet, inside page and inside current page

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

NOTE: Anchors with underscores are problematic!

For example services_autorun in the MPF documentation the underscore needs to be escaped with a \.

See Also: [services_autorun in the Masterfiles Policy Framework][Masterfiles Policy Framework#services_autorun]

Link to CFEngine keyword

The documentation pre-processor will create those automatically.

`classes` and `readfile()`

[classes][classes] and readfile()

However, the preprocess will not create links if the code word is in triple backticks:

```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

Inline code

This renders as `inline code`.

This renders as inline code.

This also renders as ```inline code```.

This also renders as inline code.

See the note above on implicit linking - single backticks will link, triple backticks won't.

Code Blocks

Code blocks are either indendented by four spaces:

Just indent by four spaces:

    $ code block
    $ without syntax highlighting

$ code block
$ without syntax highlighting

or use three backticks:

```
some more code
in a block
```

some more code
in a block

To turn on syntax highlighting, specify the brush directly after the opening three backticks. Syntax highlighting is provided by pygments. Find all available lexers here.

CFEngine Code Blocks

If you want CFEngine syntax highlighting, use

```cf3
# CFEngine block

bundle agent example()
{
}
```

# CFEngine code block

bundle agent example()
{
}

Other frequently used syntax highlighers shown below.

Bash Script Code Blocks

	```bash
	#!/bin/bash
    echo hi
    for i in `seq 1 10`;
    do
      echo $i
    done
	```

#!/bin/bash
echo hi
for i in `seq 1 10`;
do
  echo $i
done

Console Blocks

    ```console
	root@policy_server # /etc/init.d/cfengine3 stop
    ```

root@policy_server # /etc/init.d/cfengine3 stop

SQL Code Blocks

	```sql
    SELECT
         FileChanges.FileName,
         Count(Distinct(FileChanges.HostKey)) AS DistinctHostCount,
         COUNT(1) AS ChangeCount
      FROM
         FileChanges JOIN Contexts
      WHERE
         Contexts.ContextName='ubuntu'
      GROUP BY
         FileChanges.FileName
      ORDER BY
         ChangeCount DESC
	```

SELECT
     FileChanges.FileName,
     Count(Distinct(FileChanges.HostKey)) AS DistinctHostCount,
     COUNT(1) AS ChangeCount
  FROM
     FileChanges JOIN Contexts
  WHERE
     Contexts.ContextName='ubuntu'
  GROUP BY
     FileChanges.FileName
  ORDER BY
     ChangeCount DESC

Diff Code Blocks

	```diff
	diff --git a/README.md b/README.md
	index 92555a2..b49c0bb 100644
	--- a/README.md
	+++ b/README.md
	@@ -377,8 +377,12 @@ As a general note, avoiding abbreviations provides better readability.

	 * follow the [Policy Style Guide](manuals/policy-style.markdown)
	   in examples and code snippets
	-* always run it through Pygments plus the appropriate lexer (only cf3
	-  supported for now)
	+* always run it through Pygments plus the appropriate lexer
	+
	+Most important are the `cf3` lexer, as well as `bash`, `console`,
	+`diff`, `shell-session` and `postgresql`. But Jekyll supports
	+[many more lexers](http://pygments.org/docs/lexers/)
	+
	 * avoid custom color schemes and hand-coded HTML
	 * document the example after the example code
	```

diff --git a/README.md b/README.md
index 92555a2..b49c0bb 100644
--- a/README.md
+++ b/README.md
@@ -377,8 +377,12 @@ As a general note, avoiding abbreviations provides better readability.

 * follow the [Policy Style Guide](manuals/policy-style.markdown)
   in examples and code snippets
-* always run it through Pygments plus the appropriate lexer (only cf3
-  supported for now)
+* always run it through Pygments plus the appropriate lexer
+
+Most important are the `cf3` lexer, as well as `bash`, `console`,
+`diff`, `shell-session` and `postgresql`. But Jekyll supports
+[many more lexers](http://pygments.org/docs/lexers/)
+
 * avoid custom color schemes and hand-coded HTML
 * document the example after the example code

JSON Code Blocks

{% raw %}

{
  "classes":{
    "services_autorun": [ "any" ]
  }
}

{% endraw %}

{
  "classes":{
    "services_autorun": [ "any" ]
  }
}

YAML Code Blocks

{% raw %}

---
  classes:
    services_autorun:
      - "any"

{% endraw %}

---
  classes:
    services_autorun:
      - "any"

Code Blocks and Lists

If you want to include a code block within a list, put two tabs (8 spaces) in front of the entire block (4 to make the paragraph part of the list item, and 4 for it a code block):

* List item with code

        <code goes here>

  • List item with code

      <code goes here>

You can also use backticks (and get syntax highlighting) - just make sure the backticks are indented once:

1. First

	```cf3
	# CFEngine block

	bundle agent example()
	{
	}
	```

2. Second
3. Third

  1. First

    # CFEngine block

bundle agent example()
{
}

  2. Second

  3. Third

Headers

Horizontal bar

***

# Level 1

CFEngine Extensions

Example policy from core

Examples from cfengine/core can be rendered using the CFEngine_include_example macro.

  • Lines inside src starting with #@ are interpreted as markdown.

  • Wrap macro in raw and endraw tags if the file contains mustache. This allows it to be rendered correctly.

    [\%CFEngine_include_example(class-automatic-canonificiation.cf)\%]

    {% raw %} [%CFEngine_include_example(class-automatic-canonificiation.cf)%] {% endraw %}

Level 1

## Level 2

Level 2

### Level 3

Level 3

#### Level 4

Level 4

##### Level 5

Level 5

###### Level 6

Level 6

Including External Files

Sometimes it's nice to include an external file

[%CFEngine_include_markdown(masterfiles/CHANGELOG.md)%]

Including chunks of policy from the MPF

Here I am including a bundle named cfe_autorun_inventory_listening_ports. It may be a common or an agent bundle (in case the bundle ever changes types).

[%CFEngine_include_snippet(inventory/any.cf, bundle\s+(agent|common)\s+cfe_autorun_inventory_listening_ports, \})%]

[%CFEngine_include_snippet(inventory/any.cf, bundle\s+(agent|common)\s+cfe_autorun_inventory_listening_ports, })%]

body delete tidy from lib/files.cf in the MPF

[%CFEngine_include_MPF_snippet(lib/files.cf, body\s+delete\s+tidy, })%]

Comments inside documentation

Sometimes it's nice to be able to put an internal comment into the documentation that will not be rendered.

You can use the comment and endcomment tags in markdown files.

For example:

{% raw %}
{% comment %} TODO: We should try to improve this at some point.{% endcomment %}
{% endraw %}

Would render like this:

{% comment %} TODO: We should try to improve this at some point.{% endcomment %}

Sandbox

symlink example

[%CFEngine_include_snippet(masterfiles/lib/files.cf, ^body\slink_from\sln_s.*, ^##)%]

Self Documenting Policy

For the stdlib:

[%CFEngine_library_include(lib/commands)%]

For update.cf?

[%CFEngine_library_include(update)%]

for Promises.cf?

[%CFEngine_library_include(promises)%]

Variables

Referencing a version of CFEngine? Consider if that appearance should be updated with each new version.

Variables that are defined in the front matter (thats the content between the three dashes at the top) or in _config.yaml in the documentation-generator repository can be used directly within markdown.

For example this is the '{{site.CFE_manuals_version}}' version of the documentation. That variable comes from _config.yaml.

Since liquid variables look a lot like mustache variables any time you want to show the actual variables will need to be inside of raw tags.

{% raw %} site.CFE_manuals_version {{ site.CFE_manuals_version }} {% endraw %**

Testing

Indention with included markdown

  1. Verify that the selected hosts are upgrading successfully.

    • Mission Portal [Inventory reporting interface][Reporting UI#inventory management]

    • [Inventory API][Inventory API]

      root@hub:~# curl -k \
--user <admin>:<password> \
-X POST \
https://hub.localdomain/api/inventory  \
-H 'content-type: application/json' \
-d '{
      "sort":"Host name",
      "filter":{
         "CFEngine version":{
            "not_match":"{{site.cfengine.branch}}.0"
         }
      },
      "select":[
         "Host name",
         "CFEngine version"
       ]
    }'

  2. Some other thing