YAML Crash Course

Information

this quick crash course will provide you with the bit of YAML that you need to use this plugin and my naming conventions.

YAML is a file format that is designed to store Objects in it, called a notation language.

It is easy to understand for humans and machines.

And you can learn it pretty quickly, so let's start!

in YAML, you specify information by setting key - value pairs.

In YAML, they look like this:

key: value

In YAML, there are some types that values can be, but keys are always Strings.

You can just memorize them as names with no other special meaning.

Strings are just a text.

You can create them in 3 different ways.

string: Hello, I am a String!

quote-String: 'Hello, I''m a String!'

double-quote-string: "Hello, I'm a String"

Every single one has it's benefits:

Normal

faster to type, but " ' " and " " " can not be typed. Also not type safe; can not make this a e.g. number.

Quote String

Minimal, type safe, but you need to make every " ' " a " '' ".

Double Quote String

type safe, but ugly.

There are 2 types of numbers, integers and doubles.

integer: 10

double: 12.52

Booleans are yes / no, also called true / false, toggles.

true-boolean: true

false-boolean: false

Lists are a list of multiple values.

They can be typed in 2 ways:

list1:
  - 'Hello'
  - 'World'

list2: ['Hello', 'World']

empty-list: []